Data Integration
      Back to home
      1. Help Center
      2. Veonics® Portal Users Manual
      3. Data Integration

      What is the Veonics Portal API?

      An application programming interface is a way for two or more computer programs to communicate with each other in an almost real-time fashion.

      An API Specification is more of a published set of standards and rules that, when followed correctly, will establish the API software interface, connecting and executing functionality with other compliant software solutions. As a user interface connects a computer to a person, an application programming interface connects hardware or software components.

      An API is used by an authorized and technical user, who is most likely the computer programmer enabling the connections. The programmer can enable various parts of an API using a series of "calls" or requests. A program can be used, or the programmer who then enables a specific API's section creates a "call" to the portion of software the integration is required, enabling the completion of the call tasks.

      • EXAMPLE ONLY" If the record in the company's source HRIS system is "Inactive", return a "No" value and place it in the "Active" data field in the badging system.

      Veonics® Credential Database

      The Veonics Credential Database provides a REST API using the HTTP protocol. It is available for customers with the technical staff to enable it with our Veonics Portal.  For customers with limited technical staff, we recommend using our SFTP version.

      The API aims to identify the data fields in the customer's source database needed for the population and updates of records using a common unique index value in the Veonics database. 

      • EXAMPLE ONLY: (Note: include as many fields needed to match the required fields in "Record Manager" that is assigned to the associated "Record Properties or same as Card Group" in the Veonics database.
      • Field Type Description
        batch_id Number Card group ID number
        card_id String Card ID number
        field1[caption] String

        field caption
        field1(value) String field value
        field2[caption] String

        field caption
        field2(value) String field value
        field3[caption] String

        field caption
        field3(value) String field value
        field4[caption] String

        field caption
        field4(value) String field value
        field5[caption] String

        field caption
        field5(value) String field value
        field6[caption] String

        field caption
        field6(value) String field value
        field7[caption] String field caption
        field7(value) String field value
        photo[type] String photo type [jpg|png]
        photo[data] String base64 encoded photo

         

      A REST API (also known as RESTful API) is an application programming interface (API or web API) that conforms to the constraints of REST architectural style and allows for interaction with RESTful web services. REST stands for representational state transfer and was created by computer scientist Roy Fielding. (REDHAT.COM)

      Veonics Portal Cloud Logo HiRes REGISTERED-2

      Our VCDB API can be found here.

      OR

      Select this link if using the QA instance.