---
title: Explorando a API
slug: 5V2n-explorando-a-api
createdAt: 2022-07-05T21:05:07.000Z
---

Nossa API conta com uma estrutura que possui flexibilidade necessária para os desenvolvedores mais exigentes. Tenha tudo aquilo que voce precisa para implementar sua esteira de crédito.

A GYRA+ possui uma API conformante com GraphQL.
As respostas são retornadas no formato JSON, com a praticidade de escolher quais campos retornar em consultas e salvamento.

**Sobre o GRAPHQL**

GraphQL é uma linguagem de query usada na definição de dados. Com o GraphQl você pode buscar, criar, alterar ou deletar dados para uma API ou servidor.

Em GraphQL trabalhamos com dois tipos de operações:

- Query, a qual usamos para buscar dados
- Mutation, a qual usamos para criar, alterar e deletar dados

Para uma introdução mais profunda a respeito de GRAPQHL, acesse [https://graphql.org/learn/](https://graphql.org/learn/)

Exemplo de Query:

```graphql
query getUsers { 
   users {
      name
      id
   }
}
```

Recomendamos usar a ferramenta Insomnia, para fazer requisições em GraphQL corretamente.

### Ambientes

Para acessar a API de parceiros GYRA+, você precisa obter as suas credenciais (*gyramais-api-key* e *gyramais-api-secret*) no menu Configurações do seu Dashboard Parceiros GYRA+.


Você pode usar a API da GYRA+ em modo de teste (Sandbox), o que não afeta seus dados ativos ou interage com as redes bancárias. A chave API que você usa para autenticar a solicitação determina se a solicitação está no modo de produção ou no modo de teste.


### Sandbox

Utilize a url abaixo para acessar o GraphQL Playground, ou caso deseja fazer requsições via curl no ambiente de testes: <font color="#067dfa">https\://sandbox.partner.graphql.gyramais.com.br</font>

### Produção

Utilize a url abaixo para acessar o GraphQL Playground, ou caso deseja fazer requsições via curl no ambiente de produção: <font color="#077efb">https\://partner.graphql.gyramais.com.br</font>



# Explore esta documentação

Você encontrará no menu ao lado todos tutoriais e instruções necessarias para utilização da API. Sinta-se a vontade para navegar pela documentação e caso precise de ajuda, [entre em contato](#) conosco.