Se hur du integrerar med vår CRM-plattform via ett API.
Den här artikeln tar upp:
Vem är API:et till för?
Upsales har ett öppet Application Programming Interface, eller API i korthet. Kunder med färre än 100 000 anrop/dag kan använda API:et gratis.
Om du vill bygga en avancerad integration eller ladda ned data via vårt API kan det tillkomma en avgift.
Så får du åtkomst
API:et kräver tillägget API. En administratör aktiverar det under Inställningar → Konto → Abonnemangsportal, se Så aktiverar du Upsales-produkter. Bara administratörer kan se och hantera API-nycklar (Inställningar → Konto → Säkerhet → API-nycklar), se Så skapar du en API-nyckel (på engelska).
Behöver du hjälp? Vårt serviceteam kan hjälpa dig att bygga den integration du vill ha. Du kan:
- köpa tjänsten av oss
- göra det själv
- anlita en extern utvecklare
Vad du kan komma åt
Med Upsales API kommer du åt alla våra API-endpoints, till exempel CRM-API:et för att slå upp försäljningsdata eller vårt begränsade Marketing Automation-API för att skapa leads i Upsales.
Så gör du anrop
Vårt API bygger på REST. Alla anrop ska göras över SSL. Alla anrops- och svarsinnehåll, även fel, är kodade i JSON.
- Autentisera ditt konto genom att skicka med din hemliga nyckel i dina API-anrop. Som administratör hanterar du dina API-nycklar under Inställningar i Upsales. Dina API-nycklar ger omfattande behörigheter, så förvara dem säkert och borta från offentligt tillgängliga platser som GitHub eller kod på klientsidan.
- Bas-URL:en är
https://integration.upsales.com/api/v2. Skicka API-nyckeln i frågeparameterntokeni varje anrop, till exempelhttps://integration.upsales.com/api/v2/phoneCall?token=YOUR_API_KEY. Nyckeln är en del av URL:en, så håll den borta från loggar och delade länkar. - Skicka alltid med content-type: application/JSON som header.
- Vårt API returnerar vanliga HTTP-statuskoder för lyckade anrop och för fel. Vid fel skickar vi också med extra information om vad som gick fel, kodad som JSON i svaret.
| HTTP-kod | Beskrivning |
| 200 - OK | Allt fungerade som förväntat |
| 400 - Bad Request | Anropet kunde inte godtas, ofta för att en obligatorisk parameter saknas. |
| 401 - Unauthorized | Ingen giltig API-nyckel har angetts. |
| 404 - Not Found | Den begärda resursen finns inte, eller så har du inte åtkomst till den. |
| 429 - Too Many Requests | API-nyckeln har överskridit en anropsgräns. Vänta och skicka anropet igen. |
Anropen begränsas per API-nyckel. Standardgränserna är 200 anrop per 10 sekunder, 6 000 per 10 minuter och 20 000 per timme, och för POST-, PUT-, PATCH- och DELETE-anrop dessutom 2 000 per 10 minuter och 5 000 per timme. Varje svar innehåller headrarna X-RateLimit-Limit, X-RateLimit-Remaining och X-RateLimit-Reset (antal sekunder tills gränsen återställs).