Skip to content

Latest commit

 

History

History
129 lines (113 loc) · 4.82 KB

faq.adoc

File metadata and controls

129 lines (113 loc) · 4.82 KB
API

Frequently Asked Questions

This document contains answers to the most asked questions, if you have questions that are not answered in this document please refer to using our api-team email address: api@izettle.com . If you want to apply to receive access to our APIs, please fill in the form Here and we will come back to you with your credentials.


General questions

What TLS version is supported?

We are using TLS 1.2 for the moment.

How do I take payments through the iZettle API?

It is not possible to take payments through the API. However we do have an iOS SDK which supports taking payments here: https://github.com/iZettle/sdk-ios There is currently no support for Android.

Do you provide any test or sandbox environment?

Unfortunately we do not at this time, This is something we are working on to improve.


Does it cost anything to use your open APIs and is there some restriction on the API?

No, its completely free to use our API and the only limitation is that some resources and services might have rate-limiting enabled to prevent overload.


Why do i receive HTTP 100 Continue responses sometimes?

This is something our framework sends when it has received the request headers and indicates that the client should proceed to send the request body. What you can do is investigate the reason why your code does this, or you could traverse the headers until you find a header with the intended response code, examples Here and Here.


Once I have a Access token, how do I use it to authenticate myself?

The Access token is passed through the Authorization header with the format: Authorization: Bearer <Token>. Also note that on most services you can use the self filter instead of {organizationUuid}


Do I need my organization uuid when accessing some of the apis?

You can either use the self filter: see this documentation for details on how, the other option is to call

GET https://oauth.izettle.net/users/me
Example response

{
    "uuid": "de305d54-75b4-431b-adb2-eb6b9e546014",
    "organizationUuid": "ab305d54-75b4-431b-adb2-eb6b9e546013"
}

See OAuth for more info.


More to come…​

More to come…​

I’m using your API to create Products on Izettle, i have a problem when assigning images to products, i used the image API to create an image and it’s working, but how to assign this image to the product i’m creating?

 "imageLookupKeys": [
    "string" what should i put here?
  ],
  "presentation": {
    "imageUrl": "string", i should put the created image url?
    "backgroundColor": "string",
    "textColor": "string"
  },

The image api will return a imageUrl back which can be directly put into the presentation.imageUrl field, however we just introduced this and is not fully supported by the portal and the apps yet.

So if you only want to use the information outside of the iZettle apps you might want to use presentation.imageUrl, otherwise use imageLookupKeys and strip away everything except the last part of the imageUrl and place for example Ta0Tx5E6RpujkDRXheIb5w-sS5EEMfKEee84eojOmcEmQ.jpeg in the imageLookupKeys to be able to see the image in the izettle-apps.

Clarification examples:

imageLookupKeys: ["Ta0Tx5E6RpujkDRXheIb5w-sS5EEMfKEee84eojOmcEnQ.jpeg”]
"presentation" : {
      “imageUrl”: "https://image.izettle.com/v2/images/o/Ta0Tx5E6RpujkDRXheIb5w-sS5EEMfKEee84eojOmcEnQ.jpeg"

More to come…​

I cannot upload images using byte arrays.

In the Swagger documentation it specifies the data as a array of String, this is not true, make sure that The byte array is in the form:

"imageData": [-1, -40, -1, -31, 0, 24, 69, 120, 105]

and not:

"imageData": "[-1, -40, -1, -31, 0, 24, 69, 120, 105]"

Web hooks

More to come…​