oo card API overview

Create a card template using Inkscape, and name the variable elements for the Card Field Codes below, and data will be merged to that field.

Download a sample SVG file with all fields named correctly.

We can convert existing card designs to SVG templates for a small fee.

Our online template designer is coming soon. Localisation of templates coming Q4 2024.

Category	Card Field Code	Description	Card Field Label Code	Default English Field Label
Image Fields
	bg_image_front	Background Image for Front of Card	n/a	n/a
	bg_image_reverse	Background Image for Reverse of Card	n/a	n/a
	cardholder_image_main	Main Cardholder Image	t_cardholder_image_main	PHOTO
	cardholder_image_ghost	Ghost Image (opacity set in account panel)	n/a	n/a
	cardholder_signature_image	Signature Image	t_cardholder_signature	SIGNATURE
Card Features
	card_title	Card Main Title	none	n/a
	card_subtitle	Card Sub Title	none	n/a
	card_year_start	Card Year Start	none	n/a
	card_year_end	Card Year End	none	n/a
	card_flag	Card Flag Field	none	n/a
	card_serial	Card Serial Number	t_card_serial	CARD NUMBER
	card_country_code	Two Letter Country Code	t_card_country_code	n/a
	card_surn_autogen	Autogenerated Field of Characters	t_surn_autogen	n/a
	card_mrz	MRZ - Set of fields (set in account panel)	t_mrz	n/a
	card_barcode	Code 39 Barcode Field (default encodes card_serial)	t_serial_barcode	n/a
	card_pdf_barcode	PDF Barcode Field (default encodes card_serial)	t_pdf_barcode	n/a
	card_issue_date	Card Issue Date	t_card_issue_date	ISSUE DATE
	card_expiry_date	Card Expiry Date	t_card_expiry_date	EXPIRY DATE
Card Variables
	cardholder_fnam	Cardholder First Name	t_cardholder_fnam	FIRST NAME
	cardholder_snam	Cardholder Surname	t_cardholder_snam	SURNAME
	cardholder_dob	Cardholder Date of Birth (concatenated dd-mm-yyyy or mm-dd-yyyy)	t_cardholder_dob	DATE OF BIRTH
	cardholder_address	All Cardholder fields below concatenated and comma separated	t_cardholder_address	ADDRESS
	cardholder_add_1	Cardholder Address Line 1	t_cardholder_add_1	n/a
	cardholder_add_2	Cardholder Address Line 2	t_cardholder_add_2	n/a
	cardholder_add_3	Cardholder Address Line 3	t_cardholder_add_3	n/a
	cardholder_post	Cardholder Postcode	t_cardholder_post	POSTCODE
	cardholder_ctry	Cardholder Country	t_cardholder_ctry	COUNTRY
	cardholder_place_of_birth	Cardholder Place of Birth	t_cardholder_place_of_birth	PLACE OF BIRTH
	cardholder_place_of_study	Cardholder Place of Study	t_cardholder_place_of_study	PLACE OF STUDY
	cardholder_custom_field_1	Cardholder Custom Field 1	t_cardholder_custom_field_1	set in account panel
	cardholder_custom_field_2	Cardholder Custom Field 1	t_cardholder_custom_field_2	set in account panel
	cardholder_custom_field_3	Cardholder Custom Field 1	t_cardholder_custom_field_3	set in account panel
	cardholder_custom_field_4	Cardholder Custom Field 1	t_cardholder_custom_field_4	set in account panel
	cardholder_custom_field_5	Cardholder Custom Field 1	t_cardholder_custom_field_5	set in account panel

Thank you for providing the CSV. I’ll generate concise API documentation for each field based on the information given. The API endpoint is at oocard.com/cardsapi/v1/

API Documentation:

1. Image Fields:

• bg_image_front: Background Image for Front of Card
• bg_image_reverse: Background Image for Reverse of Card
• cardholder_image_main: Main Cardholder Image (Label: PHOTO)
• cardholder_image_ghost: Ghost Image (opacity set in account panel)
• cardholder_signature_image: Signature Image (Label: SIGNATURE)

2. Card Features:

• card_title: Card Main Title
• card_subtitle: Card Sub Title
• card_year_start: Card Year Start
• card_year_end: Card Year End
• card_flag: Card Flag Field
• card_serial: Card Serial Number (Label: CARD NUMBER)
• card_country_code: Two Letter Country Code
• card_surn_autogen: Autogenerated Field of Characters
• card_mrz: MRZ – Set of fields (set in account panel)
• card_barcode: Code 39 Barcode Field (default encodes card_serial)
• card_pdf_barcode: PDF Barcode Field (default encodes card_serial)
• card_issue_date: Card Issue Date (Label: ISSUE DATE)
• card_expiry_date: Card Expiry Date (Label: EXPIRY DATE)

3. Card Variables:

• cardholder_fnam: Cardholder First Name (Label: FIRST NAME)
• cardholder_snam: Cardholder Surname (Label: SURNAME)
• cardholder_dob: Cardholder Date of Birth (concatenated dd-mm-yyyy or mm-dd-yyyy) (Label: DATE OF BIRTH)
• cardholder_address: All Cardholder fields below concatenated and comma separated (Label: ADDRESS)
• cardholder_add_1: Cardholder Address Line 1
• cardholder_add_2: Cardholder Address Line 2
• cardholder_add_3: Cardholder Address Line 3
• cardholder_post: Cardholder Postcode (Label: POSTCODE)
• cardholder_ctry: Cardholder Country (Label: COUNTRY)
• cardholder_place_of_birth: Cardholder Place of Birth (Label: PLACE OF BIRTH)
• cardholder_place_of_study: Cardholder Place of Study (Label: PLACE OF STUDY)
• cardholder_custom_field_1 to 5: Cardholder Custom Fields (Labels set in account panel)

Note: Field labels in the SVG templates must match the column labels in the data feed. Some fields have static descriptions as specified in the “Card Field Label Code” column.

Certainly. I’ll provide more general information about APIs and highlight the extensible nature of your API.

API Documentation for oocard.com/cardsapi/v1/

1. Introduction:
   Our API provides a flexible and extensible solution for merging data from various sources (CSV, Excel, RESTful connections) with SVG templates to create customized cards. The API endpoint is located at oocard.com/cardsapi/v1/.
2. API Overview:

• RESTful architecture
• Supports JSON for data exchange
• Secure authentication required (details to be provided separately)
• Rate limiting may apply

1. Extensibility:
   Our API is designed to be highly extensible. While the current documentation lists specific fields, the system can accommodate additional fields and data points as needed. This allows for:

• Custom field creation
• Integration of new data sources
• Expansion of card features and variables

1. Data Integration:
   The API accepts data from multiple sources:

• CSV files
• Excel spreadsheets
• RESTful connections
  Ensure that column labels in your data sources match the field labels in the SVG templates for proper merging.

1. SVG Template Integration:

• SVG templates serve as the base design for cards
• Field labels in SVG must correspond to API field names
• Static descriptions can be set using “Card Field Label Code”

1. Available Fields:
   (Here, include the detailed field list from the previous response)
2. Custom Fields:
   In addition to predefined fields, the API supports custom fields (cardholder_custom_field_1 to 5). These can be used for additional data points specific to your use case.
3. API Requests:
   Typical API requests might include:

• POST /create_card: Submit data and template for card creation
• GET /card/{id}: Retrieve information about a specific card
• PUT /card/{id}: Update an existing card
• DELETE /card/{id}: Remove a card from the system

1. Response Formats:
   The API typically returns JSON responses, including:

• Success/failure status
• Created/updated card details
• Error messages when applicable

1. Error Handling:
   The API uses standard HTTP response codes:

• 200: Success
• 400: Bad request
• 401: Unauthorized
• 404: Not found
• 500: Internal server error

1. Versioning:
   The current version is v1. As new features are added, we may introduce new versions to ensure backward compatibility.
2. Best Practices:

• Always validate your data before sending it to the API
• Use HTTPS for all API calls to ensure data security
• Implement proper error handling in your applications
• Stay updated with API changes and new features

1. Support and Documentation:
   For additional support, detailed documentation, or to request new features, please contact our API support team.

Remember, this API is designed to grow with your needs. If you require fields or functionalities not currently listed, please reach out to discuss how we can extend the API to meet your specific requirements.