6

API

Senast uppdaterad för en månad sedan

API Dokumentation Guide för dataexport Nybörjarguide för Zapier Koppla din kalender Koppla din kalender till CRMdata

API Dokumentation

Instruktioner för CRMdatas publika API

Axel Bäckström

Senast uppdaterad för 3 månader sedan

Översikt

CRMData API ger skrivskyddad åtkomst till kunddatabaser. Den låter klienter effektivt hämta information om kunder, order, to-dos, anteckningar och fakturor. API:et är ett verktyg för din organisation för att automatisera manuellt arbete genom att sömlöst integrera API-endpunkterna med andra applikationer och program.

Skapande av API-användare

Som kund i vårt system har du möjlighet att begära ett API-konto. Åtkomsten till API:et är begränsad till autentiserade användare och följer processen nedan:

  • License schema Username: Användarnamnet som tilldelas licensinnehavaren krävs för att identifiera rätt databas för korrekt datahämtning.
    (Exempel: example@001)

Varje licensinnehavare har möjlighet att skapa en (1) API-användare. Om du inte redan har fått information om ditt API-konto, kan du begära det från info@crmdata.se. Varje API-användare får unika autentiseringsuppgifter.

  • Username: En unik identifierare för API-användaren (t.ex. api@001_api)
  • Password: Ett lösenord kopplat till användarnamnet (t.ex. test123)

Dessa uppgifter används för autentisering av API-anrop och säkerställer att endast behöriga användare kan få åtkomst till systemet. Se till att användarnamn och lösenord skickas i Authorization-headern för säker överföring av användaruppgifter. 

Base API URL

https://api.crmdata.se

Authentication and Request Parameters

Obligatoriska parametrar

Varje API-anrop måste innehålla följande parametrar i request header för att autentisera användaren och ansluta till databasen:

Exempel i Postman:

Notera att användarnamn och lösenord ska finnas i headers som en del av Basic Auth.


Notera också att du behöver lägga till ditt databasnamn (schema) i HTTP-headern. Se även till att användarnamn och lösenord är av typen Basic Auth i Authorization-headern för säkra autentiseringsuppgifter vid anrop.

Exempelsvar (URL)

Exempel-URL: https://api.crmdata.se/articles?viewPage=1
Ger data som kan se ut ungefär så här:

Exempel-URL: https://api.crmdata.se/articles/artilceId?articleId=2
Ger data som kan se ut ungefär så här:

Pagination & Authorization Reminder

Alla anrop som returnerar en lista har som standard en sidstorlek på 40. Om fler än 40 objekt finns, tillhandahålls ytterligare länkar för att navigera mellan sidor. Dessa länkar inkluderar:

  • Next: Visa nästa sida med resultat.
  • Previous: Visa föregående sida med resultat.

Observera att du för att kunna göra ett giltigt anrop alltid måste inkludera schema och Authorization i dina headers.

Articles endpoints

Alla paginerade svar har maximalt 40 artiklar per sida.

  • URL: /articles

    • Method: GET
    • Beskrivning: Hämtar en paginerad lista över alla artiklar. Standardsidan är 1.
    • Request Parameters:
      • viewPage (valfri, standard: 1): Sidnummer för pagination.

  • URL: /article/articleId

    • Method: GET
    • Beskrivning: Hämtar en artikel baserat på dess unika artikel-ID.
    • Request Parameters:
      • articleId (obligatorisk): ID för artikeln du vill hämta.

  • URL: /articles/productName

    • Method: GET
    • Beskrivning: Hämtar en artikel baserat på specificerat produktnamn.
    • Request Parameters:
      • productName (obligatorisk): Namnet på produkten som ska sökas efter.
Contacts endpoints

Alla paginerade svar har maximalt 40 kontakter per sida.

  • URL: /contacts

    • Method: GET
    • Beskrivning: Hämtar en paginerad lista över alla kontakter. Standardsidan är 1.
    • Request Parameters:
      • viewPage (valfri, standard: 1): Sidnummer för pagination.

  • URL: /contact/contactName

    • Method: GET
    • Beskrivning: Hämtar en kontakt baserat på angivet kontakt-namn.
    • Request Parameters:
      • contactName (obligatorisk): Namnet på den kontakt som ska sökas efter.

  • URL: /contacts/companyName

    • Method: GET
    • Beskrivning: Hämtar en paginerad lista över alla kontakter för en specifik kund med hjälp av kundens företagsnamn. Standardsidan är 1.
    • Request Parameters:
      • viewPage (valfri, standard: 1): Sidnummer för pagination.
      • companyName (obligatorisk): Namnet på den kund vars kontakter ska hämtas.

  • URL: /contact/contactEmail

    • Method: GET
    • Beskrivning: Hämtar en kontakt baserat på angiven e-postadress.
    • Request Parameters:
      • contactEmail (obligatorisk): E-postadressen för kontakten som ska sökas efter.

  • URL: /contacts/customerId

    • Method: GET
    • Beskrivning: Hämtar en paginerad lista över kontakter för en specifik kund med hjälp av kundens ID. Standardsidan är 1.
    • Request Parameters:
      • viewPage (valfri, standard: 1): Sidnummer för pagination.
      • customerId (obligatorisk): ID:t för kunden vars kontakter ska hämtas.

Customers endpoints

Alla paginerade svar har maximalt 40 kunder per sida.

  • URL: /customers

    • Method: GET
    • Beskrivning: Hämtar en paginerad lista över alla kunder. Standardsidan är 1.
    • Request Parameters:
      • viewPage (valfri, standard: 1): Sidnummer att hämta.

  • URL: /customers/userId

    • Method: GET
    • Beskrivning: Hämtar en paginerad lista över alla kunder som är kopplade till en specifik användare via dennes user ID. Standardsidan är 1.
    • Request Parameters:
      • userId (obligatorisk): Användar-ID för att filtrera kunder.
      • viewPage (valfri, standard: 1): Sidnummer att hämta.

  • URL: /customer/orgNumber

    • Method: GET
    • Beskrivning: Hämtar en kund via dess organisationsnummer.
    • Request Parameters:
      • orgNumber (obligatorisk): Organisationsnumret för den kund som ska hämtas.

  • URL: /customers/companyForm

    • Method: GET
    • Beskrivning: Hämtar en paginerad lista över alla kunder filtrerade efter bolagsform (t.ex. LLC, Corporation). Standardsidan är 1.
    • Request Parameters:
      • companyForm (obligatorisk): Bolagsformen för att filtrera kunder.
      • viewPage (valfri, standard: 1): Sidnummer att hämta.

  • URL: /customers/city

    • Method: GET
    • Beskrivning: Hämtar en paginerad lista över alla kunder baserade i en specifik stad. Standardsidan är 1.
    • Request Parameters:
      • city (obligatorisk): Staden där kunderna är baserade.

  • URL: /customers/companyName

    • Method: GET
    • Beskrivning: Hämtar en paginerad lista över kunder baserat på angivet företagsnamn. Standardsidan är 1.
    • Request Parameters:
      • companyName (obligatorisk): Namnet på de kunder som ska hämtas.

  • URL: /customer/customerId

    • Method: GET
    • Beskrivning: Hämtar en kund baserat på dess unika kund-ID.
    • Request Parameters:
      • customerId (obligatorisk): Det unika ID:t för kunden som ska hämtas.

  • URL: /customers/last/updated

    • Method: GET
    • Beskrivning: Hämtar en paginerad lista över alla kunder sorterade efter när kunden senast uppdaterades. Den senast uppdaterade kunden visas först. Standardsidan är 1.
    • Request Parameters:
      • viewPage (valfri, standard: 1): Sidnummer att hämta.

Notes

  • URL: /notes

    • Method: GET
    • Beskrivning: Hämtar en paginerad lista över alla anteckningar. Standardsidan är 1.
    • Request Parameters:
      • viewPage (valfri, standard: 1): Sidnummer för pagination.

  • URL: /notes/userEmail
    • Method: GET
    • Beskrivning: Hämtar en paginerad lista över alla anteckningar kopplade till en specifik användares e-postadress. Standardsidan är 1.
    • Request Parameters:
      • viewPage (valfri, standard: 1): Sidnummer för pagination.
      • userEmail (obligatorisk): Användarens e-postadress för att hämta anteckningarna.

  • URL: /notes/userId
    • Method: GET
    • Beskrivning: Hämtar en paginerad lista över alla anteckningar skrivna av en specifik användare via dennes user ID. Standardsidan är 1.
    • Request Parameters:
      • viewPage (valfri, standard: 1): Sidnummer för pagination.
      • userId (obligatorisk): Användar-ID för att hämta anteckningarna.

  • URL: /notes/companyName
    • Method: GET
    • Beskrivning: Hämtar en paginerad lista över alla anteckningar för en specifik kund via företagsnamn. Standardsidan är 1.
    • Request Parameters:
      • viewPage (valfri, standard: 1): Sidnummer för pagination.
      • companyName (obligatorisk): Kundens företagsnamn för att hämta anteckningarna.

  • URL: /notes/customerId

    • Method: GET
    • Beskrivning: Hämtar en paginerad lista över alla anteckningar för en specifik kund via kund-ID. Standardsidan är 1.
    • Request Parameters:
      • viewPage (valfri, standard: 1): Sidnummer för pagination.
      • customerId (obligatorisk): Kundens ID för att hämta anteckningarna.

  • URL: /notes/userId/customerId
    • Method: GET
    • Beskrivning: Hämtar en paginerad lista över alla anteckningar skrivna av en specifik användare för en specifik kund. Både user ID och kund-ID används. Standardsidan är 1.
    • Request Parameters:
      • viewPage (valfri, standard: 1): Sidnummer för pagination.
      • userId (obligatorisk): Användar-ID för att hämta anteckningarna.
      • customerId (obligatorisk): Kund-ID för att hämta anteckningarna.

  • URL: /notes/between/dates
    • Method: GET
    • Beskrivning: Hämtar en paginerad lista över alla anteckningar skapade mellan specifika start- och slutdatum. Standardsidan är 1.
    • Request Parameters:
      • viewPage (valfri, standard: 1): Sidnummer för pagination.
      • startDate (obligatorisk): Startdatum för intervallet.
      • endDate (obligatorisk): Slutdatum för intervallet.
Orders

  • URL: /orders

    • Method: GET
    • Beskrivning: Hämtar en paginerad lista över alla order. Standardsidan är 1.
    • Request Parameters:
      • viewPage (valfri, standard: 1): Sidnummer för pagination.

  • URL: /orders/latest

    • Method: GET
    • Beskrivning: Hämtar de senaste 50 orderna.

  • URL: /orders/userId

    • Method: GET
    • Beskrivning: Hämtar en paginerad lista över alla order som skapats av en specifik användare via dennes user ID. Standardsidan är 1.
    • Request Parameters:
      • viewPage (valfri, standard: 1): Sidnummer för pagination.
      • userId (obligatorisk): Användar-ID för att hämta order.

  • URL: /orders/customerId

    • Method: GET
    • Beskrivning: Hämtar en paginerad lista över alla order som lagts av en specifik kund via kundens ID. Standardsidan är 1.
    • Request Parameters:
      • viewPage (valfri, standard: 1): Sidnummer för pagination.
      • customerId (obligatorisk): Kundens ID för att hämta order.

  • URL: /orders/companyName

    • Method: GET
    • Beskrivning: Hämtar en paginerad lista över alla order som lagts av en specifik kund via företagsnamn. Standardsidan är 1.
    • Request Parameters:
      • viewPage (valfri, standard: 1): Sidnummer för pagination.
      • companyName (obligatorisk): Företagsnamnet för att hämta order.

  • URL: /orders/userId/customerId

    • Method: GET
    • Beskrivning: Hämtar en paginerad lista över alla order som skapats av en specifik användare för en specifik kund, filtrerat via både user ID och kund-ID. Standardsidan är 1.
    • Request Parameters:
      • viewPage (valfri, standard: 1): Sidnummer för pagination.
      • userId (obligatorisk): Användar-ID för att hämta order.
      • customerId (obligatorisk): Kundens ID för att hämta order.

  • URL: /orders/articleId

    • Method: GET
    • Beskrivning: Hämtar en paginerad lista över alla order som innehåller en specifik artikel via article ID. Standardsidan är 1.
    • Request Parameters:
      • viewPage (valfri, standard: 1): Sidnummer för pagination.
      • articleId (obligatorisk): Artikel-ID för att filtrera order.

  • URL: /orders/between/dates

    • Method: GET
    • Beskrivning: Hämtar en paginerad lista över alla order som lagts mellan specifika start- och slutdatum. Standardsidan är 1.
    • Request Parameters:
      • viewPage (valfri, standard: 1): Sidnummer för pagination.
      • startDate (obligatorisk): Startdatum för att filtrera order.
      • endDate (obligatorisk): Slutdatum för att filtrera order.

  • URL: /order/orderId

    • Method: GET
    • Beskrivning: Hämtar en order baserat på dess unika order-ID.
    • Request Parameters:
      • orderId (obligatorisk): Det unika ID:t för ordern.

  • URL: /orders/status

    • Method: GET
    • Beskrivning: Hämtar en paginerad lista över alla order med en specifik status. Standardsidan är 1.
    • Request Parameters:
      • viewPage (valfri, standard: 1): Sidnummer för pagination.
      • status (obligatorisk): Orderstatus (t.ex. ”completed”, ”pending”).

  • URL: /orders/rows

    • Method: GET
    • Beskrivning: Hämtar en paginerad lista över alla orderrader. Standardsidan är 1.
    • Request Parameters:
      • viewPage (valfri, standard: 1): Sidnummer för pagination.
Todos

  • URL: /todos

    • Method: GET
    • Beskrivning: Hämtar en paginerad lista över alla todos. Standardsidan är 1.
    • Request Parameters:
      • viewPage (valfri, standard: 1): Sidnummer för pagination.

  • URL: /todos/userId

    • Method: GET
    • Beskrivning: Hämtar en paginerad lista över alla todos som skapats av en specifik användare via dennes user ID. Standardsidan är 1.
    • Request Parameters:
      • viewPage (valfri, standard: 1): Sidnummer för pagination.
      • userId (obligatorisk): Användar-ID för att filtrera todos.

  • URL: /todos/userId/title

    • Method: GET
    • Beskrivning: Hämtar en paginerad lista över alla todos skapade av en användare med en specifik titel. Standardsidan är 1.
    • Request Parameters:
      • viewPage (valfri, standard: 1): Sidnummer för pagination.
      • userId (obligatorisk): Användar-ID för att filtrera todos.
      • title (obligatorisk): Titeln för att filtrera todos.

  • URL: /todos/companyName

    • Method: GET
    • Beskrivning: Hämtar en paginerad lista över alla todos för en kund via företagsnamn. Standardsidan är 1.
    • Request Parameters:
      • viewPage (valfri, standard: 1): Sidnummer för pagination.
      • companyName (obligatorisk): Företagsnamnet för att filtrera todos.

  • URL: /todos/customerId

    • Method: GET
    • Beskrivning: Hämtar en paginerad lista över alla todos för en kund via kundens ID. Standardsidan är 1.
    • Request Parameters:
      • viewPage (valfri, standard: 1): Sidnummer för pagination.
      • customerId (obligatorisk): Kundens ID för att filtrera todos.

  • URL: /todos/userId/customerId

    • Method: GET
    • Beskrivning: Hämtar en paginerad lista över alla todos som skapats av en specifik användare för en kund via user ID och kund-ID. Standardsidan är 1.
    • Request Parameters:
      • viewPage (valfri, standard: 1): Sidnummer för pagination.
      • userId (obligatorisk): Användar-ID för att filtrera todos.
      • customerId (obligatorisk): Kundens ID för att filtrera todos.

  • URL: /todos/triggerDate

    • Method: GET
    • Beskrivning: Hämtar en paginerad lista över alla todos med ett specifikt datum för trigger (planerat datum). Standardsidan är 1.
    • Request Parameters:
      • viewPage (valfri, standard: 1): Sidnummer för pagination.
      • triggerDate (obligatorisk): Datumet som ska användas för att filtrera todos.

  • URL: /todos/title

    • Method: GET
    • Beskrivning: Hämtar en paginerad lista över alla todos med en specifik titel. Standardsidan är 1.
    • Request Parameters:
      • viewPage (valfri, standard: 1): Sidnummer för pagination.
      • title (obligatorisk): Titeln för att filtrera todos.

  • URL: /todos/between/dates

    • Method: GET
    • Beskrivning: Hämtar en paginerad lista över alla todos mellan specifika start- och slutdatum. Standardsidan är 1.
    • Request Parameters:
      • viewPage (valfri, standard: 1): Sidnummer för pagination.
      • startDate (obligatorisk): Startdatum för att filtrera todos.
      • endDate (obligatorisk): Slutdatum för att filtrera todos.
Viktigt: Alla anrop kräver att du inkluderar schema och korrekt Authorization (Basic Auth) i förfrågningshuvudet (request header).

Var den här artikeln användbar?

1 av 1 gillade den här artikeln

Behöver du mer hjälp? Kontakta oss