1Archive help - User contributions [en]

Onea Transfer

2017-08-09T13:17:37Z

Gianni.vanhoecke:

Onea Transfer

2017-08-07T14:40:05Z

Gianni.vanhoecke: Added API key validation

= Introduction =

Sending thousands of invoices a day would have a negative impact on the stability of ScanPRO, and can be solved by a proxy. The goal of the proxy - Onea Transfer - is to take away the load on ScanPRO.

= API =

The ScanPRO Transfer API endpoint is ''<nowiki>https://transfer.onea.be</nowiki>''. Please note that only ''HTTPS'' is available.

== Upload e-Invoice ==

'''PATH''': ''/restv1/einvoice/{type}''

'''METHOD''': ''POST''

'''TYPE''': ''JSON''

'''DATA''': ''apiKey, eInvoiceData, callbackURL''

Where ''type'' is either ''incoming'' or ''outgoing''.

Both ''apiKey'' and ''eInvoiceData'' are strings and mandatory fields, ''callbackURL'' is optional. The API key(s) will be provided by Onea and is strictly personal. The e-Invoice data field must be Base64 encoded.

When your request was successfully processed, the system will return a ''200 OK'' status code with payload ''uuid''. With this UUID you can later on fetch the document ID.

If you supply a callback URL, it will be notified of any change. That way you don't need to poll, but only fetch the status after you received such notification. Please note the callback URL will be appended with the UUID. If you supply the callback URL ''<nowiki>https://myapp.com/einvoice/poke</nowiki>'', then the following URL will be called (POST) for UUID ''123'': ''<nowiki>https://myapp.com/einvoice/poke/123</nowiki>''.

=== Example ===

An example to upload an e-Invoice using cURL:

<nowiki>curl -H "Content-Type: application/json" -d '{"apiKey":"2B98577D-49DB-4E86-9DF9-F8F6726725AE","eInvoiceData":"aHR0cHM6Ly93d3cueW91dHViZS5jb20vd2F0Y2g/dj1kUXc0dzlXZ1hjUQ==","callbackURL":"https://myapp.com/einvoice/poke"}' https://transfer.onea.be/restv1/einvoice/incoming</nowiki>

Returns:

<nowiki>{"uuid":"AD85DF83-F113-46D7-B07A-28FD943A487A"}</nowiki>

== Status ==

'''PATH''': ''/restv1/einvoice/status/{uuid}''

'''METHOD''': ''GET''

'''TYPE''': ''JSON''

No API key is needed here; the authentication is implied by the UUID you got when you uploaded the e-Invoice. The UUID is a path parameter in your endpoint.

When your request was successfully processed, the system will return a ''200 OK'' status code with payload ''status, id''. The current status of the document is shown in the status field, and when ''DONE'', the ID field will contain the ScanPRO document ID. All possible status codes are ''PENDING, DONE, FAILED''.

=== Example ===

An example to fetch the e-Invoice status using cURL:

<nowiki>curl -H "Content-Type: application/json" "https://transfer.onea.be/restv1/einvoice/status/06aa265c-54b3-4d04-a585-baea0b7d41dc"</nowiki>

Returns when not yet processed:

<nowiki>{"status":"PENDING","id":null}</nowiki>

Returns when processed:

<nowiki>{"status":"DONE","id":"0123456789"}</nowiki>

Returns when failed:

<nowiki>{"status":"FAILURE","id":"0123456789","message":"Error on field 'INVNR' and SUPPCODE': Possible duplicate document with number '789' and supplier/customer 'AAA IC multi (549)' (Document 132, 456)"}</nowiki>

== API Key Validation ==

{{info|This is a protected endpoint. To access, you'll need to apply at info@onea.be}}

'''PATH''': ''/restv1/apikey/{apiKey}''

'''METHOD''': ''GET''

'''TYPE''': ''JSON''

The apiKey is a path parameter in your endpoint.

When your request was successfully processed, the system will return a ''200 OK'' status code with payload "apiKey, environment, active".

=== Example ===

An example to validate an API key using cURL:

<nowiki>curl -H "Content-Type: application/json" "https://transfer.onea.be/restv1/apikey/8D7832F2-6E10-42ED-8555-C75BF370F878"</nowiki>

Returns when all OK:

<nowiki>{"apiKey":"8D7832F2-6E10-42ED-8555-C75BF370F878","environment":"test-env","active":true}</nowiki>

Returns when no access:

<nowiki>401 Unauthorized</nowiki>

Returns on invalid API key:

<nowiki>404 Not Found</nowiki>

Onea Transfer

2017-07-13T09:23:42Z

Gianni.vanhoecke:

Onea Transfer

2017-07-13T09:19:37Z

Gianni.vanhoecke:

= Introduction =

Sending thousands of invoices a day would have a negative impact on the stability of ScanPRO, and can be solved by a proxy. The goal of the proxy - Onea Transfer - is to take away the load on ScanPRO.

= API =

The ScanPRO Transfer API endpoint is ''<nowiki>https://transfer.onea.be</nowiki>''. Please note that only ''HTTPS'' is available.

== Upload e-Invoice ==

'''PATH''': ''/restv1/einvoice/{type}''

'''METHOD''': ''POST''

'''TYPE''': ''JSON''

'''DATA''': ''apiKey, eInvoiceData, callbackURL''

Where ''type'' is either ''incoming'' or ''outgoing''.

Both ''apiKey'' and ''eInvoiceData'' are strings and mandatory fields, ''callbackURL'' is optional. The API key(s) will be provided by Onea and is strictly personal. The e-Invoice data field must be Base64 encoded.

When your request was successfully processed, the system will return a ''200 OK'' status code with payload ''uuid''. With this UUID you can later on fetch the document ID.

If you supply a callback URL, it will be notified of any change. That way you don't need to poll, but only fetch the status after you received such notification. Please note the callback URL will be appended with the UUID. If you supply the callback URL ''<nowiki>https://myapp.com/einvoice/poke</nowiki>'', then the following URL will be called for UUID ''123'': ''<nowiki>https://myapp.com/einvoice/poke/123</nowiki>''.

=== Example ===

An example to upload an e-Invoice using cURL:

<nowiki>curl -H "Content-Type: application/json" -d '{"apiKey":"2B98577D-49DB-4E86-9DF9-F8F6726725AE","eInvoiceData":"aHR0cHM6Ly93d3cueW91dHViZS5jb20vd2F0Y2g/dj1kUXc0dzlXZ1hjUQ==","callbackURL":"https://myapp.com/einvoice/poke"}' https://transfer.onea.be/restv1/einvoice/incoming</nowiki>

Returns:

<nowiki>{"uuid":"AD85DF83-F113-46D7-B07A-28FD943A487A"}</nowiki>

== Status ==

'''PATH''': ''/restv1/einvoice/status/{uuid}''

'''METHOD''': ''GET''

'''TYPE''': ''JSON''

No API key is needed here; the authentication is implied by the UUID you got when you uploaded the e-Invoice. The UUID is a path parameter in your endpoint.

When your request was successfully processed, the system will return a ''200 OK'' status code with payload ''status, id''. The current status of the document is shown in the status field, and when ''DONE'', the ID field will contain the ScanPRO document ID. All possible status codes are ''PENDING, DONE, FAILED''.

=== Example ===

An example to fetch the e-Invoice status using cURL:

<nowiki>curl -H "Content-Type: application/json" "https://transfer.onea.be/restv1/einvoice/status/06aa265c-54b3-4d04-a585-baea0b7d41dc"</nowiki>

Returns when not yet processed:

<nowiki>{"status":"PENDING","id":null}</nowiki>

Returns when processed:

<nowiki>{"status":"DONE","id":"0123456789"}</nowiki>

Returns when failed:

<nowiki>{"status":"FAILURE","id":"0123456789","message":"Error on field 'INVNR' and SUPPCODE': Possible duplicate document with number '789' and supplier/customer 'AAA IC multi (549)' (Document 132, 456)"}</nowiki>

MediaWiki:Sidebar

2017-04-07T12:38:18Z

Gianni.vanhoecke: webscanning added

Webscanning on Mac

2017-04-07T11:26:50Z

Gianni.vanhoecke: typo

= Introduction =

Currently, our webscanning tool is only available for Windows users. However, by using a virtual machine, Mac and Linux users are also capable of using said tool.

We've created an image to use with VirtualBox for you, and below we'll explain how to use it.

= How to use =

* Download the image [https://s3-eu-west-1.amazonaws.com/help.onea.be/onea_webscanning.ova here]
* Download VirtualBox [https://www.virtualbox.org/wiki/Downloads here]
* Install VirtualBox. If you have no idea how to do this, check out [https://www.youtube.com/watch?v=65T12TqxjXo this Youtube video] which will guide you through the process.
* Once installed, open VirtualBox, and select "File" > "Import Appliance..."

[[File:Onea_webscanning_01.png]]

* Select the image you downloaded in the first step, then click "Continue"

[[File:Onea_webscanning_02.png]]

* The next window gives you some information about the virtual machine, you can use the default values and just click on "Import"

[[File:Onea_webscanning_03.png]]

* Once imported, you can start your "Onea Webscanning" virtual machine

[[File:Onea_webscanning_04.png]]

* Once started, you can use one of the platforms and start scanning

[[File:Onea_webscanning_05.png]]

Webscanning on Mac

2017-04-07T11:25:51Z

Gianni.vanhoecke: initial page

= Introduction =

Currently, our webscanning tool is only available for Windows users. However, by using a virtual machine, Mac and Linux users are also capable of using said tool.

We've created an image to use with VirtualBox for you, and below we'll explain you how to use it.

= How to use =

* Download the image [https://s3-eu-west-1.amazonaws.com/help.onea.be/onea_webscanning.ova here]
* Download VirtualBox [https://www.virtualbox.org/wiki/Downloads here]
* Install VirtualBox. If you have no idea how to do this, check out [https://www.youtube.com/watch?v=65T12TqxjXo this Youtube video] which will guide you through the process.
* Once installed, open VirtualBox, and select "File" > "Import Appliance..."

[[File:Onea_webscanning_01.png]]

* Select the image you downloaded in the first step, then click "Continue"

[[File:Onea_webscanning_02.png]]

* The next window gives you some information about the virtual machine, you can use the default values and just click on "Import"

[[File:Onea_webscanning_03.png]]

* Once imported, you can start your "Onea Webscanning" virtual machine

[[File:Onea_webscanning_04.png]]

* Once started, you can use one of the platforms and start scanning

[[File:Onea_webscanning_05.png]]

File:Onea webscanning 05.png

2017-04-07T09:25:51Z

Gianni.vanhoecke:

File:Onea webscanning 04.png

2017-04-07T09:25:37Z

Gianni.vanhoecke:

File:Onea webscanning 03.png

2017-04-07T09:25:28Z

Gianni.vanhoecke:

File:Onea webscanning 02.png

2017-04-07T09:24:42Z

Gianni.vanhoecke:

File:Onea webscanning 01.png

2017-04-07T09:23:58Z

Gianni.vanhoecke:

Onea Transfer

2017-04-07T07:41:35Z

Gianni.vanhoecke: split up e-Invoice to incoming/outgoing

= Introduction =

Sending thousands of invoices a day would have a negative impact on the stability of ScanPRO, and can be solved by a proxy. The goal of the proxy - Onea Transfer - is to take away the load on ScanPRO.

= API =

The ScanPRO Transfer API endpoint is ''<nowiki>https://transfer.onea.be</nowiki>''. Please note that only ''HTTPS'' is available.

== Upload e-Invoice ==

'''PATH''': ''/restv1/einvoice/{type}''

'''METHOD''': ''POST''

'''TYPE''': ''JSON''

'''DATA''': ''apiKey, eInvoiceData, callbackURL''

Where ''type'' is either ''incoming'' or ''outgoing''.

Both ''apiKey'' and ''eInvoiceData'' are strings and mandatory fields, ''callbackURL'' is optional. The API key(s) will be provided by Onea and is strictly personal. The e-Invoice data field must be Base64 encoded.

When your request was successfully processed, the system will return a ''200 OK'' status code with payload ''uuid''. With this UUID you can later on fetch the document ID.

If you supply a callback URL, it will be notified of any change. That way you don't need to poll, but only fetch the status after you received such notification. Please note the callback URL will be appended with the UUID. If you supply the callback URL ''<nowiki>https://myapp.com/einvoice/poke</nowiki>'', then the following URL will be called for UUID ''123'': ''<nowiki>https://myapp.com/einvoice/poke/123</nowiki>''.

=== Example ===

An example to upload an e-Invoice using cURL:

<nowiki>curl -H "Content-Type: application/json" -d '{"apiKey":"2B98577D-49DB-4E86-9DF9-F8F6726725AE","eInvoiceData":"aHR0cHM6Ly93d3cueW91dHViZS5jb20vd2F0Y2g/dj1kUXc0dzlXZ1hjUQ==","callbackURL":"https://myapp.com/einvoice/poke"}' https://transfer.onea.be/restv1/einvoice/incoming</nowiki>

Returns:

<nowiki>{"uuid":"AD85DF83-F113-46D7-B07A-28FD943A487A"}</nowiki>

== Status ==

'''PATH''': ''/restv1/einvoice/status/{uuid}''

'''METHOD''': ''GET''

'''TYPE''': ''JSON''

No API key is needed here; the authentication is implied by the UUID you got when you uploaded the e-Invoice. The UUID is a path parameter in your endpoint.

When your request was successfully processed, the system will return a ''200 OK'' status code with payload ''status, id''. The current status of the document is shown in the status field, and when ''DONE'', the ID field will contain the ScanPRO document ID. All possible status codes are ''PENDING, DONE, FAILED''.

=== Example ===

An example to fetch the e-Invoice status using cURL:

<nowiki>curl -H "Content-Type: application/json" "https://transfer.onea.be/restv1/einvoice/status/06aa265c-54b3-4d04-a585-baea0b7d41dc"</nowiki>

Returns when not yet processed:

<nowiki>{"status":"PENDING","id":null}</nowiki>

Returns when processed:

<nowiki>{"status":"DONE","id":"0123456789"}</nowiki>