A seĆ§Ć£o Guias de Uso tem como objetivo apoiar desenvolvedores e parceiros que desejam entender, de forma prĆ”tica e contextual, como integrar seus sistemas Ć s APIs da Conta Azul.
Aqui, vocĆŖ encontrarĆ” os principais casos de uso das integraƧƵes, exemplos de aplicaĆ§Ć£o dos endpoints e orientaƧƵes sobre quando e como utilizar cada recurso, de acordo com o cenĆ”rio de negĆ³cio.
Enquanto a documentaĆ§Ć£o tĆ©cnica descreve os detalhes de cada endpoint como parĆ¢metros, payloads e respostas, os Guias de Uso apresentam o contexto funcional de cada tema, explicando:
- Quando utilizar determinado endpoint ou fluxo;
- Quais informaƧƵes sĆ£o necessĆ”rias para sua execuĆ§Ć£o;
- Como as APIs se relacionam entre si dentro de um processo maior (ex: vendas, baixas, contratos);
- Boas prĆ”ticas para implementaĆ§Ć£o e automaĆ§Ć£o das integraƧƵes.
š” Esses guias ajudam a compreender o objetivo e a aplicaĆ§Ć£o prĆ”tica de cada conjunto de APIs, complementando a documentaĆ§Ć£o tĆ©cnica detalhada.