Empresas
Listar Empresas
GET /v2/enterprises/
| Parâmetro | Descrição |
|---|---|
| attributes | Especifica quais atributos buscar. Pode incluir valores como 'serial', 'number', 'carrier', 'service_provider' e 'batch'. Se nulo, busca todas as informações. |
| includes | Especifica as entidades relacionadas a serem incluídas na consulta. Contém arrays para 'device' e 'enterprise', cada um com seu próprio conjunto de valores possíveis, como 'name', 'imei', 'code' para o array 'device', e 'name', 'cnpj' para o array 'enterprise'. |
| filters | Especifica filtros para vários campos como 'chips.serial', 'chips.number', 'chips.carrier', 'chips.service_provider', 'chips.batch', 'device.name', 'device.imei', 'device.code', 'enterprise.name', 'enterprise.cnpj'. Cada campo de filtro suporta condições como 'eq', 'neq', 'ilk', 'ew', 'sw'. |
| search | Especifica a consulta de busca com um comprimento máximo de 100 caracteres. |
| limit | Especifica o número máximo de resultados a retornar. Deve ser um número entre 1 e 100. |
| page | Especifica o número da página para resultados paginados. Deve ser um número maior ou igual a 0. |
| count | Indica se incluir o total de resultados na resposta. |
| sort | Especifica critérios de classificação para os campos 'number' e 'serial'. Os valores podem ser -1 (ordem decrescente) ou 1 (ordem crescente). |
Respostas
| Status | Significado | Descrição |
|---|---|---|
| 200 | OK | Resposta Padrão |
| 400 | Bad Request | Solicitação Inválida |
Esta operação não requer autenticação
Criar Empresas
POST /v2/enterprises/
Dados de Envio
{
"body": {
"data": {
"attributes": {
"name": "Example Company",
"cnpj": "12345678901234",
"timezone": "America/New_York",
"phone1": "(123) 456-7890",
"phone2":"(123) 123-4567",
"email": "info@example.com",
"contact_name": "John Doe",
"webpage": "http://example.com",
"assistance_emergency_tel": "911",
"theft_emergency_tel": "911",
"fantasy_name": "Example"
},
"relationships": {
"country": {
"type": "country",
"id": "abc1234567890def"
}
}
}
}
}| Campo | Descrição | Obrigatório |
|---|---|---|
| data | Objeto contendo atributos e relacionamentos de dados. | sim |
| attributes | Objeto contendo atributos da empresa. | sim |
| - name | String com o nome da empresa, comprimento máximo de 250 caracteres. | sim |
| - cnpj | String com o CNPJ da empresa, comprimento máximo de 25 caracteres. | sim |
| - timezone | String com o fuso horário da empresa, deve ser uma string de fuso horário válida da lista de fusos horários conhecidos, ou nulo. | sim |
| - phone1 | String com o número de telefone principal da empresa, comprimento máximo de 100 caracteres, ou nulo. | não |
| - phone2 | String com o número de telefone secundário da empresa, comprimento máximo de 100 caracteres, ou nulo. | não |
| String com o endereço de e-mail da empresa, comprimento máximo de 100 caracteres, ou nulo. | não | |
| - contact_name | String com o nome de contato da empresa, comprimento máximo de 100 caracteres, ou nulo. | não |
| - webpage | String com o URL da página da empresa, comprimento máximo de 255 caracteres, ou nulo. | não |
| - assistance_emergency_tel | String com o número de telefone de emergência para assistência da empresa, comprimento máximo de 100 caracteres, ou nulo. | não |
| - theft_emergency_tel | String com o número de telefone de emergência para roubo da empresa, comprimento máximo de 100 caracteres, ou nulo. | não |
| - fantasy_name | String com o nome fantasia da empresa, comprimento máximo de 100 caracteres, ou nulo. | não |
| relationships | Objeto contendo informações de relacionamento. | sim |
| - country | Objeto representando o relacionamento com um país. | não |
| -- type | String com o tipo de relacionamento, deve ser 'country'. | sim |
| -- id | String com o ID do país, deve consistir em 15 caracteres alfanuméricos. | sim |
Respostas
| Status | Significado | Descrição |
|---|---|---|
| 200 | OK | Resposta Padrão |
| 400 | Bad Request | Um de 'Bad Request' ou 'Failed to Create Enterprise' |
Esta operação não requer autenticação
Mostrar Empresas
GET /v2/enterprises/{id}
| Parâmetro | Descrição | Obrigatório |
|---|---|---|
| attributes | Um array opcional de strings especificando os atributos a serem recuperados. Os atributos válidos incluem 'name', 'phone1', 'phone2', 'email', 'contact_name', 'created_at', 'updated_at', 'deactivated_at', 'cnpj', 'webpage', 'timezone', 'assistance_emergency_tel', 'theft_emergency_tel', 'fantasy_name'. Se nulo, todas as informações são recuperadas. | não |
| includes | Um objeto opcional especificando entidades relacionadas a serem incluídas na consulta. Contém arrays para 'endereços' e 'documento'. Cada array pode incluir valores como 'formatted_address', 'city', 'region', 'zip_code', 'file_size', 'created_at', 'folder', 'key_name', 'mime', 'name'. | não |
| - addresses | Um array de atributos de endereço para incluir na resposta. Atributos válidos incluem 'formatted_address', 'city', 'region', 'zip_code'. | não |
| - document | Um array de atributos de documento para incluir na resposta. Atributos válidos incluem 'file_size', 'created_at', 'folder', 'key_name', 'mime', 'name'. | não |
Respostas
| Status | Significado | Descrição |
|---|---|---|
| 200 | OK | Resposta padrão |
| 400 | Bad Request | Solicitação Inválida |
| 401 | Unauthorized | Não Autorizado |
| 404 | Not Found | Não Encontrado |
Esta operação não requer autenticação
Atualizar Empresas
PATCH /v2/enterprises/{id}
Dados de Envio
{
"body": {
"data": {
"attributes": {
"name": "Example Company",
"cnpj": "12345678901234",
"timezone": "America/New_York",
"phone1": "(123) 456-7890",
"phone2":"(123) 123-4567",
"email": "info@example.com",
"contact_name": "John Doe",
"webpage": "http://example.com",
"assistance_emergency_tel": "911",
"theft_emergency_tel": "911",
"fantasy_name": "Example"
},
"relationships": {
"country": {
"type": "country",
"id": "abc1234567890def"
}
}
}
}
}| Campo | Descrição | Obrigatório |
|---|---|---|
| data | Objeto contendo atributos e relacionamentos de dados. | sim |
| attributes | Objeto contendo atributos da empresa. | sim |
| - name | String com o nome da empresa, comprimento máximo de 250 caracteres. | sim |
| - cnpj | String com o CNPJ da empresa, comprimento máximo de 25 caracteres. | sim |
| - timezone | String com o fuso horário da empresa, deve ser uma string de fuso horário válida da lista de fusos horários conhecidos, ou nulo. | sim |
| - phone1 | String com o número de telefone principal da empresa, comprimento máximo de 100 caracteres, ou nulo. | não |
| - phone2 | String com o número de telefone secundário da empresa, comprimento máximo de 100 caracteres, ou nulo. | não |
| String com o endereço de e-mail da empresa, comprimento máximo de 100 caracteres, ou nulo. | não | |
| - contact_name | String com o nome de contato da empresa, comprimento máximo de 100 caracteres, ou nulo. | não |
| - webpage | String com o URL da página da empresa, comprimento máximo de 255 caracteres, ou nulo. | não |
| - assistance_emergency_tel | String com o número de telefone de emergência para assistência da empresa, comprimento máximo de 100 caracteres, ou nulo. | não |
| - theft_emergency_tel | String com o número de telefone de emergência para roubo da empresa, comprimento máximo de 100 caracteres, ou nulo. | não |
| - fantasy_name | String com o nome fantasia da empresa, comprimento máximo de 100 caracteres, ou nulo. | não |
| relationships | Objeto contendo informações de relacionamento. | sim |
| - country | Objeto representando o relacionamento com um país. | não |
| -- type | String com o tipo de relacionamento, deve ser 'country'. | sim |
| -- id | String com o ID do país, deve consistir em 15 caracteres alfanuméricos. | sim |
Respostas
| Status | Significado | Descrição |
|---|---|---|
| 200 | OK | Resposta padrão |
| 400 | Bad Request | Solicitação Inválida |
| 401 | Unauthorized | Não Autorizado |
| 404 | Not Found | Não Encontrado |
Esta operação não requer autenticação
Excluir Empresas
DELETE /v2/enterprises/{id}
Parâmetros
{
"params": {
"id": "ABC1234567890DEF"
}
}| Campo | Descrição | Obrigatório |
|---|---|---|
| id | String especificando o ID. Deve ser alfanumérico e exatamente 15 caracteres. | sim |
Respostas
| Status | Significado | Descrição |
|---|---|---|
| 200 | OK | Resposta padrão |
| 400 | Bad Request | Um de 'Bad Request', 'Cannot Delete Self Enterprise', 'Cannot Delete a Main Client Enterprise', 'Cannot Delete Enterprise With Other Affiliations', 'Invalid Affiliation', 'Enterprise Not Affiliated' ou 'Cannot Delete Enterprise With Devices, Chips, Vehicles or Users' |
| 401 | Unauthorized | Não Autorizado |
| 404 | Not Found | Não Encontrado |
Esta operação não requer autenticação
Atualizar {situation} Empresas
PATCH /v2/enterprises/{id}/status/{situation}
Parâmetros
{
"params": {
"id": "ABC1234567890DEF",
"situation": "activation"
}
}| Campo | Descrição | Obrigatório |
|---|---|---|
| id | String contendo o ID, deve seguir o padrão alfanumérico e ter um comprimento de 15 caracteres. | sim |
| situation | String indicando a situação, deve ser 'activation' ou 'deactivation'. | sim |
Respostas
| Status | Significado | Descrição |
|---|---|---|
| 200 | OK | Resposta padrão |
Esta operação não requer autenticação