Este documento descreve o retorno esperado de uma chamada de API que gera uma chave de acesso. Os dados de exemplo apresentados abaixo são fictícios e servem para ilustrar a estrutura e o significado de cada campo no retorno da resposta.
{
"success": true,
"msg": "access key generated successfully",
"body": {
"id": 4257393,
"access_key": "string",
"url": null,
"status": "active",
"tipo": "API-watch-Label",
"ip_access": "string",
"created_at": "2024-11-04 10:44:02",
"updated_at": "2024-11-04 10:44:02"
}
}
| Atributo | Descrição |
|---|---|
| id (integer) | Identificador único da chave de acesso gerada. |
| access_key (string) | Chave de acesso gerada para autenticação de API. |
| url (string | null) | URL associada à chave de acesso, se aplicável. |
| status (string) | Status da chave de acesso (ex.: ‘active’, ‘inactive’). |
| tipo (string) | Tipo de chave de acesso, indicando o propósito (ex.: ‘API-watch-Label’). |
| ip_access (string) | Endereço IP autorizado para usar a chave de acesso. |
| created_at (string) | Data e hora de criação da chave de acesso no formato YYYY-MM-DD HH:MM. |
| updated_at (string) | Data e hora da última atualização da chave de acesso no formato YYYY-MM-DD HH:MM. |