O processo de listagem das empresas é feito somente após a validação das credenciais, dessa forma, é impossível que a company de uma Software House seja listada por outra.
Este método retorna uma lista com todas as companies cadastradas.
GET
Sandbox:
https://pix.tecnospeed.com.br/sandbox/companies
Produção:
https://pix.tecnospeed.com.br/api/v1/companies
Autohorizations: Outh2
oauth2 (softwarehouse:full)
Fluxo para autenticação.
Exemplo de Credenciais:
ID_Company: seu-client-id
Secret_Company: seu-client-secret
Exemplo de response:
{
"access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpJ9.zI1NiIs",
"expires_in": 3600,
"token_type": "Bearer"
}clientCredentialsToken URL: https://pix.tecnospeed.com.br/oauth2/token
Query Parameters
| Campo | Tipo | Descrição | Exemplo |
| name | string | Nome da company a ser listada | name=João da Silva |
|
|
string | Email da company a ser listada | email=teste@teste.com.br |
| cpfCnpj | string | CPF/CNPJ da company a ser listada | cpfCnpj=01001001000113 |
| limit | number | Número máximo de registros por página | limit=10 |
| page | number | Pagina que será exibida | page=2 |
| sort | string |
Enum: "ASC" "DESC" Tipo de ordenação dos registros por data de criação, podendo ser crescente (ASC) ou decrescente (DESC) |
sort=DESC |
Retorno
{
"page": 0,
"totalPages": 0,
"totalRecords": 0,
"results": [
{
"id": "4b0da80a-fbe0-4226-9808-ed05b9e62f01",
"surrogateKey": "4b0da80a-fbe0-4226-9808-ed05b9e62f01",
"name": "Ingá Softwarehouse",
"email": "contato@ingsoft.com.br",
"cpfCnpj": "32052710000151",
"zipcode": "87045170",
"city": "Maringá",
"state": "PR",
"status": "ACTIVE",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"deletedAt": "2019-08-24T14:15:22Z"
}
]
}
Listar Empresas por ID
GET
Sandbox:
https://pix.tecnospeed.com.br/api/v1/companies/{id}
Produção:
https://pix.tecnospeed.com.br/sandbox/companies/{id}
Autohorizations: Outh2
oauth2 (softwarehouse:full)
Fluxo para autenticação.
Exemplo de Credenciais:
ID_Company: seu-client-id
Secret_Company: seu-client-secret
Exemplo de response:
{
"access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpJ9.zI1NiIs",
"expires_in": 3600,
"token_type": "Bearer"
}clientCredentialsToken URL: https://pix.tecnospeed.com.br/oauth2/token
PATH Parameters
| Campo | Tipo | Descrição |
| companyID | string | Identificador único da empresa. |
Retorno
{
"id": "4b0da80a-fbe0-4226-9808-ed05b9e62f01",
"surrogateKey": "4b0da80a-fbe0-4226-9808-ed05b9e62f01",
"name": "Ingá Softwarehouse",
"email": "contato@ingsoft.com.br",
"cpfCnpj": "32052710000151",
"zipcode": "87045170",
"city": "Maringá",
"state": "PR",
"status": "ACTIVE",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"deletedAt": "2019-08-24T14:15:22Z"
}
Comentários
0 comentário
Por favor, entre para comentar.