General Information
Authentication
Only authenticated users can make API requests. The Gini API uses the OAuth 2.0 protocol with bearer tokens for authentication from untrusted devices and a simplified authentication scheme for trusted devices/systems (backend or gateway) based on basic auth.
In order to use the API in your application, register your application with Gini. Afterwards, your application should request an access token from the Gini Authorization Server and use it to access the Gini Pay API.
Security
The Gini Pay API is only accessible over HTTPS. Make sure your application validates the relevant X.509 certificates, such as, common name matches hostname or issuing CA is trusted. The Gini Pay API and User Center are accessible from legacy IPv4 and IPv6 networks. The protocol precedence depends on your operating system and configuration if both protocols are enabled.
| Code Block |
|---|
|
//IPv6 compatibility example
$ host pay-api.gini.net
pay-api.gini.net has address 46.245.182.123
pay-api.gini.net has IPv6 address 2a00:14e0:600:1500:d0c5::7
$ host user.gini.net
user.gini.net has address 46.245.182.124
user.gini.net has IPv6 address 2a00:14e0:600:1500:d0c5::2 |
| Rw pagetree macro |
|---|
| title | Section overview |
|---|
rootPage | @currentWelcome! Follow along these pages to configure your application and start using the Gini Pay API.| Rw ui steps macro |
|---|
Start with authentication and security topics then find out how to send your documents for processing retrieve results and send back the transfer summary Learn how to manage user accounts and why it is important If you’re migrating from the old API, make sure you check out the migration page as well. |
...
Once you read and complete the steps below, our API will be ready to work with your application:
| Cfm card |
|---|
| externalUrl | https://gini.atlassian.net/wiki/spaces/PA1/pages/45154479/Accessing+the+API |
|---|
| color | #FFFFFF |
|---|
| filterSpace | false |
|---|
| destination | externalUrl |
|---|
| textColorPalette | Default |
|---|
| title | Access Gini Pay API |
|---|
| body | Who can access and use Gini Pay API? |
|---|
| textColor | #000000 |
|---|
| target | true |
|---|
| layout | Simple |
|---|
| selectedUrl | https://gini.atlassian.net/wiki/spaces/PA1/pages/45154479/Accessing+the+API |
|---|
| an.spaceKey | PA1 |
|---|
| id | 1nbcu5ysv4i |
|---|
| backgroundColorPalette | Default |
|---|
|
| Cfm card |
|---|
| externalUrl | https://gini.atlassian.net/wiki/spaces/PA1/pages/36896828/How+to+Process+Documents |
|---|
| color | #FFFFFF |
|---|
| filterSpace | false |
|---|
| destination | externalUrl |
|---|
| textColorPalette | Default |
|---|
| title | Process documents |
|---|
| body | How to process documents? |
|---|
| textColor | #000000 |
|---|
| target | true |
|---|
| layout | Simple |
|---|
| selectedUrl | https://gini.atlassian.net/wiki/spaces/PA1/pages/36896828/How+to+Process+Documents |
|---|
| an.spaceKey | PA1 |
|---|
| id | 8f84e82nimo |
|---|
| backgroundColorPalette | Default |
|---|
|
| Cfm card |
|---|
| externalUrl | https://gini.atlassian.net/wiki/spaces/PA1/pages/31686793/How+to+Manage+Gini+Accounts |
|---|
| color | #FFFFFF |
|---|
| filterSpace | false |
|---|
| destination | externalUrl |
|---|
| textColorPalette | Default |
|---|
| title | User accounts |
|---|
| body | How to Manage user accounts? |
|---|
| textColor | #000000 |
|---|
| target | true |
|---|
| layout | Simple |
|---|
| selectedUrl | https://gini.atlassian.net/wiki/spaces/PA1/pages/31686793/How+to+Manage+Gini+Accounts |
|---|
| an.spaceKey | PA1 |
|---|
| id | h1blw8d2m1 |
|---|
| backgroundColorPalette | Default |
|---|
|
| Cfm card |
|---|
| externalUrl | https://gini.atlassian.net/wiki/spaces/PA1/pages/30934365/Migrating+from+api.gini.net |
|---|
| color | #FFFFFF |
|---|
| filterSpace | false |
|---|
| destination | externalUrl |
|---|
| textColorPalette | Default |
|---|
| title | Migrating from deprecated API |
|---|
| body | Migrating from api.gini.net |
|---|
| textColor | #000000 |
|---|
| target | true |
|---|
| layout | Simple |
|---|
| selectedUrl | https://gini.atlassian.net/wiki/spaces/PA1/pages/30934365/Migrating+from+api.gini.net |
|---|
| an.spaceKey | PA1 |
|---|
| id | cyh8tb1ni8 |
|---|
| backgroundColorPalette | Default |
|---|
|