Payload API (1.0.0)
Download OpenAPI specification:Download
Google Spreadsheet: O Endpoint Google Spreadsheet existe também nas peças da nossa plataforma Builder. Veja mais sobre manipulação de planilhas na nossa documentação.
S3: Este Endpoint também está localizado dentro da plataforma, podemos usá-los nos próprios blocos. Veja aqui como você pode estar fazendo.
Adicionar uma linha
Adiciona uma linha com a string inserida em uma tabela do Google Sheets.
Authorizations:
path Parameters
| id required | any |
Request Body schema: application/json
| row | Array of strings |
Responses
Request samples
- Payload
{- "row": [
- "string"
]
}Response samples
- 400
- 401
- 403
- 422
- 500
{- "message": "Não foi possível adicionar uma nova linha."
}Pegar várias células
Retorna os valores das células dos intervalos escolhidos nos parâmetros.
Authorizations:
path Parameters
| id required | any |
query Parameters
| row_start required | any |
| col_start required | any |
| row_end required | any |
| col_end required | any |
Responses
Response samples
- 200
- 400
- 401
- 403
- 422
- 500
{- "result": [
- {
- "R1C0": "column_1",
- "R1C1": "column_2",
- "R1C2": "column_3"
}
]
}Mostrar a tabela
Retorna em forma de tabela os dados divididos por cabeçalhos.
Authorizations:
path Parameters
| id required | any |
query Parameters
| row_start required | any |
| col_start required | any |
| row_end required | any |
| col_end required | any |
Responses
Response samples
- 200
- 400
- 401
- 403
- 422
- 500
{- "result": [
- {
- "header_1": "column_1",
- "header_2": "column_2",
- "header_3": "column_3"
}
]
}Pegar valor específico da tabela
Retorna o conteúdo da seleção passada por query, junto com o cabeçalho.
Authorizations:
path Parameters
| id required | any |
query Parameters
| range required | any |
Responses
Response samples
- 200
- 400
- 401
- 403
- 422
- 500
{- "result": [
- {
- "header_1": "column_1",
- "header_2": "column_2",
- "header_3": "column_3"
}
]
}Definir cabeçalho
Adiciona um cabeçalho na planilha com as strings colocadas no corpo.
Authorizations:
path Parameters
| id required | any |
query Parameters
| tab_index required | any |
Request Body schema: application/json
| header | Array of strings |
Responses
Request samples
- Payload
{- "header": [
- "string"
]
}Response samples
- 400
- 401
- 403
- 422
- 500
{- "message": "Não foi possível definir o cabeçalho."
}Validar ID
Verifica se existe uma planilha com o ID indicado. Para a API poder funcionar corretamente, a planilha precisa estar compartilhada com a service account do Google que o payload usa para se comunicar com a API do Google Spreadsheets.
Authorizations:
path Parameters
| id required | any |
Request Body schema: application/json
| header | Array of strings |
Responses
Request samples
- Payload
{- "header": [
- "string"
]
}Response samples
- 400
- 401
- 403
- 422
- 500
{- "message": "Não foi possível definir o cabeçalho."
}Enviar um documento para a S3
Hospeda o documento enviado em um bucket do S3 e retorna a URL de acesso.
Authorizations:
Request Body schema: application/json
| url | string <hostname> Se o documento tiver dados EXIF, a localização será extraída dele |
| userId | string <uuid> Você pode achar este parâmetro dentro da plataforma Builder, cada usuário tem o seu próprio ID. |
| bot | string Nome do bot ao qual irá armazenar o documento no bucket |
object Se fornecido, as coordenadas dos documentos serão extraídas desta propriedade em vez do documento | |
| company | string Se fornecido, salva o documento neste subdiretório |
Responses
Request samples
- Payload
{- "url": "example.com",
- "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
- "bot": "string",
- "coord": {
- "lat": 0,
- "long": 0
}, - "company": "string"
}Response samples
- 201
- 401
- 403
- 422
- 500
Retornar um documento
Retorna um documento do S3 pela key.
Authorizations:
path Parameters
| bot_name required | string O nome do bot ao qual o documento pertence |
| key required | string A chave do objeto. Deve ser codificado em URL |
Responses
Response samples
- 401
- 403
- 422
- 500
{- "message": "Nenhum token enviado com a requisição."
}