> For the complete documentation index, see [llms.txt](https://docs.yoplanning.support/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.yoplanning.support/pt/developpeur/documentation-api-yoplanning.md).

# Documentação da API do Yoplanning

### Introdução

A API do Yoplanning é estruturada em torno do princípio REST. Nossa API oferece URLs previsíveis e orientadas a recursos, e utiliza códigos de resposta HTTP para indicar erros e sucessos nas chamadas à API. Aproveitamos recursos HTTP integrados, como autenticação HTTP e verbos HTTP, que são compreendidos por clientes HTTP padrão. Todos os métodos em nossa API retornam JSON.

### Autenticação

Para começar, você precisa solicitar um token de API para consultar a API do Yoplanning. Para isso, entre em contato conosco. Assim que tiver seu token, você poderá começar a usar a API. Todos os métodos da API exigem autenticação.

Utilizamos um sistema de autenticação padrão baseado em token. Para autenticar, basta fornecer seu token de API no cabeçalho de cada solicitação, da seguinte forma: `Authorization: Token 4804c2cb4d87a13146d4de029f407c82149f2ada`. Observação: o espaço entre "Token" e o nome do token é importante.

Aqui está um exemplo completo usando curl:

```
curl -H "Content-Type: application/json" https://yoplanning.pro/api/v3.1/teams/5a90332e-568f-4980-9859-88a984844a4d/clients/8d23503e-041e-4180-98d1-641183bc5ead -H 'Authorization: Token 4804c2cb4d87a13146d4de029f407c82149f2ada'
```

Caso você não forneça um token ou se o token for inválido, a API responderá com um código HTTP 401 (Não autorizado) e fornecerá um campo "detalhes" no JSON da resposta para ajudá-lo a entender o problema.

### Permissões

Ao solicitar seu token de API, você recebeu permissões específicas para um determinado conjunto de equipes. Isso significa que provavelmente você não poderá usar todos os métodos da API. Se você chamar a API do Yoplanning sem as permissões necessárias, a API responderá com um erro HTTP 403 (Proibido).

### Limitação de solicitações

Por motivos de segurança, o número de solicitações que você pode fazer é limitado. Os limites aplicáveis ​​estão especificados na especificação da API, seção "Throttling": <https://yoplanning.pro/api/v3.1/swagger/>. Ao ultrapassar esses limites, a API responderá com o código HTTP 429 (Muitas solicitações).

### Visão geral

#### Equipe

A equipe é o conceito mais fundamental no Yoplanning (que é uma ferramenta colaborativa). Quase todos os métodos recebem um parâmetro `teamId` na URL, o que significa que todas as ações estão relacionadas a uma equipe.

#### UUID

Muitos métodos exigem um parâmetro "pk" na URL. Este é o identificador único do recurso que você está tentando recuperar, criar, atualizar ou excluir. O Yoplanning usa UUID (versão 4) como identificador único para todos os recursos.

#### Pontos de extremidade e verbos HTTP

Para muitos recursos, dois pontos de extremidade estão disponíveis:

* Uma para acessar uma instância específica. A URL geralmente termina com `<pk>`.
* Para acessar o gerenciador de instâncias: Esses endpoints usam os seguintes verbos HTTP:
  * GET: obtém uma lista de todos os recursos (consulte Paginação)
  * POST: Criar um novo recurso (O identificador será gerado pelo servidor)

#### Chamada

Para todos os métodos da API que fornecem uma grande lista de recursos, a paginação é utilizada. Isso significa que nem todos os resultados serão retornados em uma única solicitação. Você precisará fazer várias solicitações para obter a lista completa de recursos.

#### Filtros

Para alguns endpoints, você pode filtrar os resultados adicionando parâmetros de consulta à solicitação.

#### Campos extensíveis

Para alguns endpoints, o objeto de recurso contém recursos aninhados. Para evitar o envio de mais solicitações, você pode usar o mecanismo de expansão de campos: adicione o parâmetro de consulta `expand` à URL para incluir diretamente um recurso aninhado na resposta. Por exemplo: `?expand=product`. Você pode solicitar vários campos separando-os por vírgulas e campos profundamente aninhados usando a notação de ponto, por exemplo: `?expand=session_group.product`.


---

# 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://docs.yoplanning.support/pt/developpeur/documentation-api-yoplanning.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.
