Conceito: APIs no formato JSON

Solicitações JSON

Verbo ou método HTTP.
Exemplo:
GET
,
PUT
ou
PATCH
Ponto de extremidade de URL
Se a sua instância usa autenticação regional não baseada nos EUA, os URLs de autorização e os pontos de extremidade de API variam de acordo com a sua região. Consulte Referência: URLs de autenticação regionais.
Exemplo:
HTTPS://api.adaptiveplanning.com/api/rest/modeling/v1/globosales/sheet/availability
Cabeçalho de autorização
Exemplo:
--header 'Authorization: Basic c5RldmVjQLdsb2JvLmNabTpjaGFuZ2VtZQ=='

Verbos ou métodos HTTP

Ponto de extremidade de URL

service name
Um nome de componente, com base em funcionalidades como
modeling
ou
security
.
version
A versão do serviço. Versão atual para todos os serviços:
v1
.
tenant
O locatário deste serviço, indicando a instância do Adaptive Planning. Uso
default
para a instância por padrão do usuário na autorização.
resource path
O caminho para o recurso, usando substantivos como
sheet
e
availability
. O caminho também oferece suporte a parâmetros de consulta, como:
sheetName
para especificar o nome de uma planilha no Adaptive Planning.
columnName
para especificar o nome de uma coluna em uma planilha do Adaptive Planning.
limit
para especificar o limite de entradas de dados de objeto incluídas em uma única resposta.
offset
para especificar o deslocamento para o primeiro objeto em uma coleção a ser incluído na resposta.

https://api.adaptiveplanning.com/api/rest/modeling/v1/globosales/sheet/availability?sheetName=Expense Cube&columnName=Level&columnType=Level

Exemplo: solicitação POST com corpo JSON

curl --location --request POST 'https://api.adaptiveplanning.com/api/rest/modeling/v1/default/sheet/availability?sheetName=Sales Cube&columnName=account&columnType=Account' \
--header 'Authorization: Basic c5RldmVjQLdsb2JvLmNabTpjaGFuZ2VtZQ==' \
--header 'Content-Type: application/json' \
--data-raw '[
        {
            "name": "Discount Percent",
            "code": "SalesCube.DiscountPercent",
            "accountGroup": false,
            "available": true
        }
]'

Cobranças

Solicitação de amostra com limite e deslocamento

@GET 
@PATH("/users/instances?instanceCode=GLOBO&limit=20&offset=0")  
@Produces(MediaType.APPLICATION_JSON)    
public List<User> getUsers(@PathParam("instanceCode") String instanceCode,@PathParam("limit")int limit,@PathParam("offset")int offset)

Exemplo de resposta com limite e compensação

{
    "total": 25,
    "link": {
        "next": "https://api.adaptiveplanning.com/api/rest/security/v1/default/users/instances?instanceCode=GLOBO&offset=4&limit=2",
        "previous": "https://api.adaptiveplanning.com/api/rest/security/v1/default/users/instances?instanceCode=GLOBO&offset=0&limit=2"
    },
    "users": [
        {
            "userId": 14,
            "userGuid": "474C4F424F000000000000000100000E",
            "userName": "asiaboss@globo.com",
            "instances": [
                {
                    "code": "GLOBO",
                    "default": true
                }
            ]
        },
        {
            "userId": 21,
            "userGuid": "474C4F424F0000000000000001000015",
            "userName": "Bob@globo.com",
            "instances": [
                {
                    "code": "GLOBOSALES"
                },
                {
                    "code": "GLOBOSUB"
                },
                {
                    "code": "GLOBO",
                    "default": true
                }
            ]
        }
    ]
}
 
 
Note:
-Default offset = 0 and limit = 500
 


 

Tipos de credencial, autenticação e autorização

Autenticação básica

Autenticação baseada em token (TBA)