APIs REST¶
Esta documentação tem como objetivo orientar o uso das APIs do FoccoERP desenvolvidas com o padrão REST (Representational State Transfer).
APIs Disponívies¶
As APIs do FoccoERP estão separadas por contextos e possuem licenciamento comercial individual, desta forma o seu uso pode variar conforme a versão atual do sistema e os contextos adquiridos comercialmente.
Documentação
A página de documentação pode ser acessada em <URL base do FoccoERP>/api/docs.
Autenticação¶
A autenticação nas APIs é feita através do Bearer Authentication, utilizando um token de acesso chamado de Bearer Token. Para realizar a autenticação, o consumidor/usuário deve informar esse token no header da requisição, conforme o exemplo abaixo:
Authorization: Bearer <token>
Token de Acesso
A geração de um token de acesso é realizado através do programa Cadastro de Tokens de Acesso (FUTL0243).
Autenticação x Autorização
Quando a requisição não estiver autenticada, a chamada da API irá retornar o código de erro 401 - Unauthorized.
Quando a requisição estiver autenticada e não autorizada, a chamada da API irá retornar o código de erro 403 - Forbidden.
Códigos de Status¶
| Código | Descrição | Indica |
|---|---|---|
| 200 | Ok | A requisição foi bem sucedida |
| 201 | Created | A requisição foi bem sucedida e um novo recurso foi criado |
| 207 | Multi-Status | A requisição foi bem sucedida e pode retornar vários status de resposta |
| 400 | Bad Request | A requisição é inválida (conteúdo incorreto) |
| 401 | Unauthorized | A requisição não está autenticada |
| 403 | Forbidden | A identidade autenticada na requisição não tem autorização para acessar o recurso |
| 404 | Not Found | O recurso não foi encontrado |
| 422 | Unprocessable Entity | A request está correto, porém alguma regra de negócio impediu a execução do método |
| 500 | Internal Server Error | Erro interno na aplicação |