> For the complete documentation index, see [llms.txt](https://help.blazon.im/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://help.blazon.im/capacidades/capacidades-da-plataforma/api.md).

# API

## Aviso legal <a href="#aviso-legal" id="aviso-legal"></a>

Este documento contém informações operacionais e comerciais relacionadas aos serviços da Plataforma Blazon e destina-se exclusivamente ao uso informativo da Contratante.

A reprodução, adaptação, reutilização ou utilização deste material para fins comerciais, concorrenciais ou quaisquer finalidades distintas de sua utilização informativa relacionada à Plataforma Blazon dependerá de autorização prévia e formal da Blazon.

## 1. Visão Geral

A capacidade de **APIs** disponibiliza interfaces REST que permitem a integração da Plataforma Blazon com aplicações, serviços e sistemas externos, possibilitando automatizar processos, consultar informações e executar operações de forma segura e padronizada.

Todas as APIs seguem um modelo consistente de autenticação, autorização, auditoria e controle operacional, permitindo que integrações sejam desenvolvidas de forma escalável e alinhadas às políticas de segurança da organização.

## 2. Recursos

Os recursos abaixo representam as principais funcionalidades disponibilizadas pela API da Plataforma Blazon, permitindo que aplicações e serviços externos realizem integrações de forma segura, controlada e padronizada.

<table data-header-hidden data-search="false"><thead><tr><th width="291.265625">Recurso</th><th>Descrição</th></tr></thead><tbody><tr><td><strong>APIs REST</strong></td><td>Disponibiliza um conjunto de endpoints para integração com os recursos da Plataforma Blazon.</td></tr><tr><td><strong>Controle de Permissões</strong></td><td>Permite controlar quais operações podem ser executadas por cada consumidor da API.</td></tr><tr><td><strong>OAuth 2.0</strong></td><td>Utiliza OAuth 2.0 como protocolo de autorização para acesso aos recursos protegidos.</td></tr><tr><td><strong>Throttling</strong></td><td>Permite limitar a quantidade de requisições realizadas por consumidores da API, protegendo os serviços contra uso excessivo.</td></tr><tr><td><strong>Auditoria</strong></td><td>Registra operações que realizam alterações na plataforma, garantindo rastreabilidade das modificações realizadas por meio das APIs.</td></tr><tr><td><strong>Debug</strong></td><td>Permite habilitar o registro detalhado das requisições para apoiar atividades de desenvolvimento e diagnóstico.</td></tr></tbody></table>

### 2.1 Modelo de Segurança

A Plataforma Blazon adota um conjunto de mecanismos de segurança para proteger o acesso às APIs, garantindo que apenas consumidores autorizados possam acessar os recursos disponibilizados, com controle de permissões, auditoria e proteção contra uso indevido.

<table><thead><tr><th width="291.078125">Componente</th><th>Descrição</th></tr></thead><tbody><tr><td>Autorização</td><td>Controle de acesso baseado em permissões da plataforma.</td></tr><tr><td>OAuth 2.0</td><td>Autorização baseada em tokens de acesso.</td></tr><tr><td>Auditoria</td><td>Registro das operações que alteram informações.</td></tr><tr><td>Throttling</td><td>Controle da quantidade de requisições.</td></tr><tr><td>HTTPS</td><td>Comunicação segura utilizando TLS.</td></tr></tbody></table>