Urls API

General:

Basics:

Base-URL: https://capi.lagerkoll.com/v1/url/

Parameters in the url should all be encoded and all data sent should be UTF-8

MAX number of requests per minute is set to 200.
When the limit is hit an error with code 429 is returned, with the header "Retry-After" containing the number of seconds you have to wait for your next request.

Headers:

There are 2 ways to be authenticated when using this API. in both ways you add headers to the request.
1) Use an API-key together with store-id. This would be used when communicating machine to machine and no real person is involved. The API-key is available from where you activated the API. The store-id is also available in the same place.
2) Use a user_id and user_token together with a store-id. You get these values from the login-request. The values are connected to a person and are gained when an actual login to the system has been made.

store: <<STORE>>
user_id: <<USER_ID>>
user_token: <<USER_TOKEN>>
api_key: <<API_KEY>>
Accept: application/json
Content-Type: application/json

Errors:

Code	Description
900001	Credentials don't match
900101	Common error
900429	Too many requests
902201	Error when getting Url
902202	Error when creating a Url

{
  "errorCode" : 900101,
  "errorMessage" : "Something went wrong on the server",
  "errorField" : null,
  "errorData" : null
}

Urls API:

Url

Get short url

GETUrl:

Headers:

Accept: application/json or application/xml

Get short url from already created long url

Valid parameters:

Parameter	Description	Default value	Allowed values
url

Body:

Successfull response:

ShortUrl

{"url": "url"}

Redirect url

GETUrl: /{url}

Headers:

Redirect to where the short url points

Body:

Successfull response:

Create url

POSTUrl:

Headers:

Accept: application/json or application/xml

Create a new short url based on long url

Valid parameters:

Parameter	Description	Default value	Allowed values
url

Body:

Successfull response:

ShortUrl

{"url": "url"}

Classes:

ShortUrl

Field	Type	Description	Default	Mandatory	Accepted values	Example values	Access
url	String						R