Felkoder

När du skickar en request till Pushas API kan det uppstå diverse olika fel, vi försöker då returnera en lämplig felkod för att du enkelt ska kunna förstå vad som har gått fel.

HTTP-Statuskod

Vi försöker i möjligaste mån att alltid returnera en lämplig HTTP-statuskod. Om du t.ex. frågar efter ett användarnamn som inte finns så kommer du få "404 Not Found" redan i HTTP-headern. Följande HTTP-statuskoder kan du få som svar från Pushas API:

200 OK

Denna statuskod indikerar att allt gick bra.

400 Bad Request

Detta fel uppstår om requesten är formulerad på fel sätt, om du t.ex. glömt att ange linkID trots att det är ett krav för den metod du försöker använda.

403 Forbidden

Forbidden får du t.ex. om du försöker ställa en fråga till API:et med en felaktig API-nyckel.

404 Not Found

Detta fel kan uppstå om du t.ex. försöker hämta en användare som inte existerar, men det kan även uppstå om du försöker använda en metod som inte finns. Titta efter så du inte stavat fel om du får detta fel.

500 Internal Server Error

Detta är ett oförutsett fel som innebär att något är fel hos oss. Får du detta fel får du gärna kontakta oss så att vi blir uppmärksammade på att något är galet.

API-felkoder

Förutom statuskoderna så försöker vi, i de fall det är möjligt, att skicka med en intern felkod och ett meddelande som är mer specifikt för att du snabbare ska förstå vad som är fel. Som programmerare bör du i dina applikationer använda dig av felkoderna (alltså siffra) istället för meddelandet eftersom vi kan ändra meddelandet. Felkoden och meddelandet skickas med i det format som requesten bad om i de fall format-parametern finns specifierad. Här följer en lista på del fel vi kan skicka med:

  • 1001 - Unknown Error
  • 1002 - You are not using a valid API-key
  • 1003 - You've reached the API rate limit. You can only make 100 api-requests per hour.
  • 1010 - There is no user with this username
  • 1011 - The username you provided was invalid or empty
  • 1012 - Invalid userField for orderBy
  • 1020 - There is no link with this id
  • 1021 - The link id you provided was invalid or empty
  • 1022 - Invalid linkField for orderBy
  • 1030 - There is no comment with this id
  • 1031 - There comment id you provided was invalid or empty
  • 1032 - Invalid commentField for orderBy
  • 1040 - There is no event with this id
  • 1041 - There event id you provided was invalid or empty
  • 1042 - Invalid eventField for orderBy

Ignorerade fel

Vissa användarfel ignoreras av api:et. Du måste självklart ange en korrekt api-nyckel men vissa parametrar ignoreras om du skickar med ett ogiltigt värde och använder sig då istället av sitt default-värde. Skickar du t.ex. med format=html (som inte är giltigt) så kommer du få tillbaka i formatet xml. Sätter du limit=200 så kommer du ändå bara få tillbaka max 100 resultat o.s.v.

Dokumentation

Metoder
Noder