API Store

Production and Sandbox Endpoints

Production and Sandbox URLs:

Description

A API foi desenvolvida para realizar a integração entre o SGT e sistemas legados dos regionais. O acesso aos recursos da API é através de autenticação `OAuth2` e, para isso, é necessário assinar a API e obter o Consumer Key e Consumer Secret do Store. Logo após, obter o token de acesso e utilizá-lo para acessar o recurso desejado. Para mais informações de como obter e utilizar o token, acesse a documentação oficial da [WSO2](https://docs.wso2.com/display/AM1100/Token+API). Toda troca de informação, consulta e inserção de dados, é no formato `JSON`, bastando apenas enviar o *HEADER* `application/json`. A obtenção do token utiliza *HEADER* `application/x-www-form-urlencoded`.Também é possível trabalhar com o formato `XML`, exceto na obtenção do token, utilizando o *HEADER* `application/xml`. Estamos trabalhando com APIs `REST` e com isso os recursos respeitam os verbos HTTP conforme abaixo: ``` GET - Para buscar informações sobre um objeto POST - Para criar objetos PUT - Para atualizar objetos``` Nenhum objeto pode ser excluído do SGT, por este motivo não trabalhamos com o verbo `DELETE`. No entanto, às vezes as coisas dão errado, e nesse caso você pode ter uma resposta padrão de erro: ``` { "code": 0, "message": "string" } ``` Toda requisição que não passar pelas regras de negócio específicas do SGT irão retornar o código HTTP `422` e dentro do payload o código referente a cada regra abaixo: ``` 4221 - Campo obrigatório não enviado -- Retornado quando falta algum campo obrigatório em qualquer tipo de requisição 4223 - Objeto não pertence ao regional -- Retornado quando enviado inserções ou edições em objetos que não pertencem ao regional 4224 - Regra de negócio não validada -- Retornado quando enviado inserções ou edições que não obedeçam as regras de negócios 4225 - Chave primária não encontrada -- Retornado quando enviado campos que precisam ser consultados a chave primária e a mesma não for encontrada ``` Os recursos abaixo estão agrupados por tipo de recurso e documentados com todos os campos de filtros de consultas e exemplos de payloads e responses. Para maiores informações você pode entrar em contato!

Share

• Social Sites
• Embed
• Email

Comments