> For the complete documentation index, see [llms.txt](https://docs.airops.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.airops.com/docs/pt/acoes/workflow-concepts/workflow-steps/logic-steps/api.md).

# Chamar API

Chame APIs externas no seu workflow

O passo utilitário "API" permite que os seus workflows da AirOps comuniquem com serviços externos através das respetivas APIs. Isto permite integrar e interagir com dados e funcionalidades que estão fora do seu workflow.

## Configuração

Escolha o método exigido pela API externa:

| Método    | Uso comum                                                                      |
| --------- | ------------------------------------------------------------------------------ |
| **GET**   | Recuperar dados. Este é o método predefinido e não envia corpo da solicitação. |
| **POST**  | Criar um recurso ou submeter dados.                                            |
| **PUT**   | Substituir ou atualizar um recurso.                                            |
| **PATCH** | Atualizar campos selecionados de um recurso.                                   |

**POST**, **PUT**, e **PATCH** aceitar um **Corpo** com referências Liquid. O passo não suporta DELETE. As tentativas de repetição configuradas aplicam-se aos quatro métodos suportados.

### Referenciar Entradas ou Saídas no Passo API

Para definir dinamicamente variáveis na sua API e referenciar uma entrada (definida no passo "Start") ou uma variável de saída (gerada por qualquer passo), terá de usar a sintaxe Liquid. Além disso, terá de especificar os valores dos seus Cabeçalhos e do Corpo.

#### Cabeçalhos

Para passar o valor do cabeçalho, é importante formatar a informação como JSON. Definiremos sempre o nosso Content-Type como mostrado abaixo, e pode incluir a Chave de API para quaisquer chamadas que exijam autorização:

```javascript
{ 
    "authorization": "Bearer YOUR_API_KEY",
    "Content-Type": "application/json"
}
```

#### Corpo

O corpo permite-nos especificar quaisquer parâmetros adicionais (ou seja, variáveis ou saídas) a incluir na chamada API. Usamos a mesma sintaxe do cabeçalho, em que tanto as nossas chaves como os valores estão entre aspas. Se estivermos a passar entradas ou saídas de passos, usamos a sintaxe Liquid, mantendo ainda as aspas duplas, por exemplo,

```javascript
{
  "properties": {
    "amount": "",
    "dealname": "{{ step_2.output.deal_name }}",
    "pipeline": "",
    "closedate": "{{ step_2.output.deal_close_date }}",
    "dealstage": "",
    "hubspot_owner_id": ""
  }
}
```

#### Exemplos

Vamos juntar tudo isto com alguns exemplos. Se tiver uma entrada de utilizador definida como location no início do seu Workflow, pode incluir {{ location }} no URL ou corpo do seu passo API para fazer um pedido a uma API meteorológica:

```
GET https://api.weatherapi.com/v1/current.json?key=YOUR_API_KEY&query={{ location }}
```

Da mesma forma, pode usar saídas de outros passos como variáveis. Se tiver um passo que recupera o ID de um utilizador, pode usar a saída desse passo como variável no passo API:

```
POST https://api.example.com/user/{{ step_1.output }}/profile
```

Isto permite criar pedidos de API dinâmicos que se ajustam com base nas entradas e saídas no seu workflow. Como exemplo, pode fazer referência ao passo API mostrado no nosso modelo "Sales Call Lead Qualifier" apresentado abaixo:

<figure><img src="https://31915162-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FX2n5yPRPynbnWuO4SH0M%2Fuploads%2Fgit-blob-a065521ad54d200f3084fb0592a7097497a6aa58%2Fapi-step-01-example.png?alt=media" alt="Call API step Get the Transcript from Fireflies sending a POST request to the Fireflies GraphQL API with headers and a body, followed by a Qualify the lead step"><figcaption><p>O passo Call API obtém uma transcrição da chamada do Fireflies.</p></figcaption></figure>

## Como continuar se o passo API falhar

Por predefinição, o passo API terminará o workflow se falhar. No entanto, para continuar o workflow se o passo falhar, basta clicar em `Continuar` na parte inferior do passo.

<figure><img src="https://31915162-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FX2n5yPRPynbnWuO4SH0M%2Fuploads%2Fgit-blob-c22e0f91e9ed6f30b38662ce911f8280e9c9bdf4%2Fstep-errors-03-continue-strip.png?alt=media" alt="Web Page Scrape step with When the step fails set to Continue"><figcaption><p>Selecione Continuar para manter o Workflow em execução quando o passo falhar.</p></figcaption></figure>

O passo devolverá as seguintes chaves:

* `saída` : será `nulo`
* `erro` :
  * `mensagem`: a mensagem devolvida pelo passo
  * `código` : o código de erro que representa o erro

<figure><img src="https://31915162-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FX2n5yPRPynbnWuO4SH0M%2Fuploads%2Fgit-blob-42ed8e1d814a64451a4759ec04fab8fc35e89eff%2Fstep-errors-01-error-variable.png?alt=media" alt="Variables Menu previewing the Export pass schedule step, whose output is null and whose error has a message and the code STEP_ERROR"><figcaption><p>Um passo falhado devolve um objeto de erro com uma mensagem e um código.</p></figcaption></figure>

## Como tentar novamente se o passo API falhar

Pode tentar novamente o passo API até 3 vezes clicando em **Definições avançadas**

No entanto, se o passo continuar a falhar após 3 tentativas, pode:

1. Selecione `Continuar` em vez de `Terminar Workflow` se o passo falhar
2. Adicione uma condição em que a condição verifique se o `erro` do passo existe, por exemplo `step_1.error`
3. Adicione o passo que pretende tentar novamente se houver um erro

<figure><img src="https://31915162-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FX2n5yPRPynbnWuO4SH0M%2Fuploads%2Fgit-blob-0cf37b9938c96511e3d7292034d8f5dc8c74d168%2Fstep-errors-02-retry-condition.png?alt=media" alt="Condition step Retry if export failed that checks step_1.error, with the retry Run Code step on the True branch"><figcaption><p>Verifique se o passo falhou e tente novamente.</p></figcaption></figure>

## Precisa de mais controlo?

Para pedidos API avançados, use o nosso passo Python com código personalizado, usando o [Passo de Código](https://docs.airops.com/docs/code-step), que pode fazer pedidos externos.


---

# 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.airops.com/docs/pt/acoes/workflow-concepts/workflow-steps/logic-steps/api.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.
