> For the complete documentation index, see [llms.txt](https://kb.stoque.com.br/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://kb.stoque.com.br/abaris/zeev-sead/apis-e-json/utilizando-o-json-na-geracao-de-documentos-sead.md).

# Utilizando o JSON na geração de documentos (SEAD)

Aqui você vai entender melhor sobre o uso do JSON no Ábaris

{% hint style="info" %}
A sua instituição recebe os fluxos todos prontos do nosso time de Projetos SEAD. Ou seja, você não precisa se preocupar com esses fluxos. **Nosso time já deixa tudo certinho para você!**
{% endhint %}

#### Swagger

Para entender sobre a geração do JSON, e até mesmo testá-lo, é importante que você tenha acesso aos endereços do Swagger, nossa ferramenta interativa de documentação e teste das APIs, onde você já tem uma descrição completa com os endpoints, métodos, parâmetros e respostas, além da possibilidade de testar seu código e alguns exemplos.

[SWAGGER DOCUMENT API 1.0](https://documents.abaris.com.br/swagger/index.html)

[SWAGGER WORKFLOW API 1.0](https://workflow.abaris.com.br/swagger/index.html)

[SWAGGER SEAD API 1.05](https://seadapi.abaris.com.br/swagger/index.html)

### Exemplo de utilização

Os documentos mais utilizados pelas Secretarias Acadêmicas, por exemplo, são: currículo, histórico e diploma e a API que gera esses documentos é o endpoint "sample" que está no SEAD API 1.05.

Ao selecionar o "sample" do Diploma, você precisa configurar alguns parâmetros booleanos (true ou false), como se o diploma é digital ou não (NSF), se é uma segunda via e se é válido judicialmente. Após selecionar os parâmetros, ou um deles, basta clicar em EXECUTE e você verá o código JSON com informações randômicas.\
**Dica:** você pode baixar esses dados para o seu editor de códigos e fazer as substituições necessárias para ficar conforme a sua instituição.

Quanto aos diplomas, por exemplo, o MEC tem uma documentação padronizada para que esses parâmetros, variáveis e atributos, como chamamos no Ábaris, estejam corretos no momento em que o arquivo se converterá para XLS. [Vale a pena acessar o arquivo XSD](http://portal.mec.gov.br/diplomadigital/index.php?pagina=pacote-instituicoes).

{% hint style="warning" %}
Às SEADs um reforço: você deve estar por dentro da documentação disponibilizada pelo MEC, pois ela é requerida para uma geração de diploma válido, por exemplo.
{% endhint %}


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://kb.stoque.com.br/abaris/zeev-sead/apis-e-json/utilizando-o-json-na-geracao-de-documentos-sead.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.