kivra/developer.kivra.com

API Documentation, etc

developer.kivra.com's Issues

Unable to run the site locally

I did as instructed:

$ docker-compose up
Starting developerkivracom_app_1_5f0e7a0febca ... done
Attaching to developerkivracom_app_1_5f0e7a0febca
app_1_5f0e7a0febca | == The Middleman is loading
app_1_5f0e7a0febca | == View your site at "http://localhost:4567", "http://127.0.0.1:4567"
app_1_5f0e7a0febca | == Inspect your site configuration at "http://localhost:4567/__middleman", "http://127.0.0.1:4567/__middleman"

...but the site served at localhost:4567 doesn't really work:

/tenant/{tenantKey}/company returns field with name vatnr instead of vat_number

/tenant/{tenantKey}/company
should return Company object which has key and vat_number

however the current sandbox implementation instead returns key and vatnr

So current return is
[{"vatnr":"SE9164xxxxxx01","key":"148585xxxx"}]
but expected is
[{"vat_number":"SE9164xxxxxx01","key":"148585xxxx"}]

is it the Company object that is incorrect for all cases, or is it the endpoint that should refer to a different object instead?

Require Single Enum value

developer.kivra.com/swagger.yml

Line 2826 in a473da8

content_type:

it says "The image format must be PNG." and still we need to assign it as a enum string?
Could it not just default to "image/png" when left empty?

Missing error descriptions.

Hello, Kivra.
During testing today we got the following undocumented error codes.
The following errors came when we tried to add an icon

/v2/tenant/{tenantKey}/icon

Tried to upload a 1px large image.
40030: IconSizeError

Tried to upload a gif.
40028: UnsupportedFileType

They are not present in the error codes section.

With regards Niklas, InExchange.

Example responses have text 'undefined'

It says 'undefined' above many of the example responses which gives the impression that there is something wrong.

Create tenant uses 40018 error code in an undocumented way.

Hello, Kivra.
I'll create a public issue for this for tracking purposes even if its just closed.

When creating a tenant via using the method /v2/tenant the request fails when the organization is a sole proprietor(Enskild Firma).

The error it gives is 40018: The request can't be processed due to company_id not meeting the required format.

The specific details of how we found this was sent to @paolokivra via private email.

Include or link to Finnish documentation 🇫🇮

The APIs are going to be at least a bit different for Finland. Given the site's URL, readers are going to assume the current documentation applies to Finland, as well.

We should either include the Finnish documentation on this site or make it clear where to find it.

Unexpected requirement after creating a tenant

It says on the site that after creating a tenant

The created tenant is automatically added to the client scope.

Which is technically true, but the client needs to re-authenticate for the new scope to be in effect. I would suggest that we mention the need for re-auth in that section.