Controlo de Erros

Erros de autenticação

Sempre que existe um erro de autenticação, é devolvido o HTTP status code 400. O corpo da resposta é no formato:

{
	error: string,
	error_description: string

}

Os erros possíveis são os seguintes:

Erros de dados

A forma mais fácil de entender o workflow de um pedido que devolva erro, é testar com um exemplo na SandBox ou nos seus scripts.

Vamos tentar fazer update ao perfil do utilizador através do método updateMe da classe myProfile, falhando o preenchimento de alguns campos e inserir um endereço de e-mail inválido.

Os parâmetros enviados são:

<?php
	$my_data = array(
		'name' => '',
		'email' => 'fake email',
		'cellphone' => '123456789',
		'language_id' => 'xpt'
	);
?>

Ao efetuar a chamada sem alguns dados, ou com dados no formato errado, a API devolve a seguinte resposta:

[
	[0] => 1 name,
	[1] => 3 email,
	[2] => 2 language_id 1 0
]

Em caso de erro, a resposta vem sempre no formato "Código de erro + espaço + Nome do campo".

Perante esta resposta, devemos interpretar da seguinte forma:

[
	/* O array tem 3 índices, por isso a resposta devolve 3 erros */
	[0] => 1 name, /* código de erro 1. Significa que o campo name é obrigatório */
	[1] => 3 email, /* código de erro 3. Significa que o campo email tem um endereço de e-mail inválido*/
	[2] => 2 language_id 1 0 /* código de erro 2 1 0. Significa que o campo language_id um inteiro numérico e superior a zero (0) */
]

Erros verbosos:

Caso queira que lhe seja devolvida uma mensagem de erro mais verbal de forma a que o erro seja facilmente entendido pelo utilizador, poderá enviar por GET o parâmetro human_errors=true, e será-lhe devolvido um array com as mensagens de erro no seguinte formato:

[
	[0] => 
		[code] => 1 name,
		[description] => "Field 'name' is required" 
	[1] => 
		[code] => 3 email,
		[description] => "Field 'email' must be a valid email address"
	[2] => 
		[code] => 2 language_id 1 0,
		[description] => "Field 'language_id' must be integer, greater than 0"
]

A tabela seguinte, apresenta todos os códigos e respetivos significados para que possa perceber qual o erro devolvido pela API.

Tabela de erros devolvidos pela API