Histórico da Página

...

[
    {
        "id": "ce429b8e-e284-44c7-a37c-d7dfbb0b7aed",
        "name": "safra",
        "description": "Safras",
        "details": [
            {
                "id": "56c53717-727b-4b33-bfcd-57b6f85d20df",
                "query": "SELECT CD_SAFRA, DE_SAFRA, DE_COMP_TBL FROM SAFRAS WHERE CD_SAFRA = ::codigo",
                "httpMethod": "GET",
                "path": "/api/v1/safras",
                "enabled": true
            },
            {
                "id": "bf3bbf43-cb35-4cc7-8c50-4c441772d4ce",
                "query": "INSERT INTO SAFRAS(CD_SAFRA, DE_SAFRA, DE_COMP_TBL) VALUES (::codigo,::descricao,::complemento)",
                "httpMethod": "POST",
                "path": "/api/v1/safras",
                "enabled": true
            },
            {
                "id": "23856856-2b8b-48a4-988d-38a20dba7209",
                "query": "UPDATE SAFRAS SET DE_SAFRA = ::descricao, DE_COMP_TBL = ::complemento WHERE CD_SAFRA = ::codigo",
                "httpMethod": "PUT",
                "path": "/api/v1/safras",
                "enabled": true
            },
            {
                "id": "4ddbba69-91a3-4f6e-92c3-92cd24a8619a",
                "query": "DELETE FROM SAFRAS WHERE CD_SAFRA = ::codigo",
                "httpMethod": "DELETE",
                "path": "/api/v1/safras",
                "enabled": true
            }
        ]
    }
]

Consumo das APIs

Composição da URL da API

A URL para as entidades e queries cadastradas é composta confome conforme configurado no cadastro da EntityAPI e QueryHe/QueryDe, para os campos apiVersion e pathUrl, conforme demonstrado a  seguir:

• Entidade: http://IP:PORTA/api/entity/[apiVersion]/[pathUrl]
• Query: http://IP:PORTA/api/query/[apiVersion]/[pathUrl]

Segurança / Autenticação

A autenticação/autorização das APIs de integração utiliza o OAuth 2.0 Client Credentials Grant, sendo o método mais utilizado e também um fluxo de autorização projetado especificamente para integrações entre sistemas backend.

Principais vantagens:

• As credenciais do cliente são mantidas seguras e o token de acesso é temporário e pode ser revogado.
• Suporta múltiplos clientes e permite o controle granular de permissões e acessos.
• Amplamente adotado e suportado por muitos provedores de serviços, garantindo interoperabilidade entre sistemas diferentes.

Fluxo:

• Cliente realiza requisição para o servidor de autorização com as credenciais Client Id e Client Secret;
• Servidor verifica as credenciais, estando válidas retorno um token de acesso;
• Cliente utiliza o token de acesso para autenticar as requisições feitas para o servidor de recursos;

---

🔗 Vídeo de demonstração/apresentação do "TOTVS Agro API Hub" (acesso TOTVS)

...