Set up web services in portal

Disclaimer

All screenshots in the article were taken in the Dutch version of Yuki.

A web service contains one or more methods for exchanging information with third-party applications/services. Among other things, you can think of financial data, submission of data from sales invoices and accessing and uploading to the Yuki archive.

The (web service API key is used to grant web service access at portal, domain or administration level.

For a detailed description of webservice access at domain or administration level, see article Setting up Webservices in domain and.or administration. 

ATTENTION!

To use the Purchase web service, a formal request must be sent by email to [email protected].

You will then receive a Client ID/Secret by email from Yuki. You will need this in addition to the API key for authentication in order to gain access to the Purchase web service.

TIP!

If you no longer trust the security of the API key, generate a new API key. Then copy the API key to use it in your application.

Only a user with the role 'Portal administrator' role can set (access) rights to web services in the portal by means of the web service API key. 

These then apply to all domains and administrations to which the portal administrator has access.

A user with the 'Portal back office' role has no access to the settings of web services.

From this screen, a user with the 'Portal Administrator' role can:

• view the web service calls
• add a new API key
• view the data of an API key
• change the web service of an API key
• delete an API key.

In the accountant portal, click on the Settings icon at the top right of your screen.

Then, in the now-opened screen, click on Web services.

The following screen is opened in the Web service API keys view by default:

Views

You can also specify in this screen that the Web service calls view should be shown:

Here you can see per domain how often a certain web service (indicating the type of API key) has been called (calls).

In this view you can filter the data shown by web service, portal (or sub-portal) or period.

By default, each domain has 1000 Web service calls (calls) available per day.

To increase the number of available web service calls (calls), a user with the 'Portal Administrator' role has the option to add one of the following accountant features to the domain: 

• Yuki Web service (from 1000 to a maximum of 5000 calls per day)
• Yuki Web service Extended (from 5000 to a maximum of 10,000 calls per day).

Add new API key

To activate web services for the portal and generate an access key, click on the Add new API key button.

The following screen is opened:

Then choose the (access) rights for the desired Web services and click on the Save button. 

The new API key has been added.

You can select (access) permissions to the following web services:

• Financial:
  • Accounting web service:
    • Retrieve financial reporting
    • Creation of journal entries
  • AccountingInfo web service:
    • Retrieve information about general ledger accounts and transactions
• Archive (Archive web service):
  • Retrieve and submit documents
  • Consultation (via app) in the archive.
• Sales (Sales web service);
  • Creation of sales invoices (UBL).
• Workflow (Upload web service);
  • Upload documents/files
• Cash (PettyCash web service);
  • Import cash transactions
• UBL:
  • Export of UBL invoices
• Contacts (Contact web service):
  • Create or update contact.
• Projects (Projects web service):
  • Creation of projects (files).
  • Modification of existing projects (files).
• Domains (Domains web service):
  • Creation of active domains and trial domains by accountants.
  • Retrieval and creation of users in a domain.
• Contacts (read only) (Contact web service):
  • Retrieve contact data.
• Back office (Back office web service):
  • Checking open questions for back office in administration
  • Retrieving back office workflow from administration
  • Checking specific backoffice roles of portal users in domain
  • Update specific backoffice roles of portal users in domain.
• Purchasing (Purchase web service);
  • Creation of purchase invoices.

ATTENTION!

When submitting sales invoices from a Webshop, the Invoicing (old Sales) or bundle Small, Medium, Large or Unlimited must have been selected by a user with the 'Management' role through the Yuki Store in the domain because based on the data from the link, sales invoices are generated and processed in Yuki.

View API key data

To view the data of an API key, hover your mouse over the line of the corresponding API key, click on the button with the three dots, and then select View API key data from the dropdown menu.

For a detailed description, see article View and/or change web service API key details.

Change web service(s) of API key

To change the details of an API key, hover your mouse over the line of the corresponding API key, click on the button with the three dots, and then select Change Web Service API key from the dropdown menu.

For a detailed description, see article View and/or change web service API key details.

Delete an API key

To delete an API key, hover your mouse over the line for that API key, click on the button with the three dots, and then select Delete from the dropdown menu.

The following message appears on your screen:

Click on the Delete button to actually delete the API key.

ATTENTION!

All web services connected by using this API key will be changed.