Skip to content

api2cart/C-Qt-Client-sdk

Repository files navigation

C++ Qt API client

API2Cart OpenAPI

  • API version: 1.1
  • Generator version: 7.11.0

API2Cart

Automatically generated by the OpenAPI Generator

Requirements

Building the API client library requires:

  1. CMake 3.2+
  2. Qt
  3. C++ Compiler

Getting Started

example.h:

#include <iostream>
#include "../client/OAIAccountApi.h"

using namespace test_namespace;

class Example : public QObject {
    Q_OBJECT
    OAIAccountCartAdd create();
public Q_SLOTS:
   void exampleFunction1();
};

example.cpp:

#include "../client/OAIAccountApi.h"
#include "example.h"
#include <QTimer>
#include <QEventLoop>

OAIAccountCartAdd Example::create(){
    OAIAccountCartAdd obj;
 return obj;
}

void Example::exampleFunction1(){
     OAIAccountApi apiInstance;
     
      // Configure API key authorization: ApiKeyAuth
      apiInstance.setApiKey("YOUR API KEY NAME","YOUR API KEY");

      QEventLoop loop;
      connect(&apiInstance, &OAIAccountApi::accountCartAddSignal, [&]() {
          loop.quit();
      });
      connect(&apiInstance, &OAIAccountApi::accountCartAddSignalE, [&](QNetworkReply::NetworkError, QString error_str) {
          qDebug() << "Error happened while issuing request : " << error_str;
          loop.quit();
      });

      OAIAccountCartAdd oai_account_cart_add = create(); // OAIAccountCartAdd | 
      apiInstance.accountCartAdd(oai_account_cart_add);
      QTimer::singleShot(5000, &loop, &QEventLoop::quit);
      loop.exec();
  }

Documentation for Servers

Parameterized Servers are supported. Define a server in the API for each endpoint with arbitrary numbers of variables:

servers:
- url: http://{server}:{port}/{basePath}
  description: Description of the Server
  variables:
    server:
        enum:
          - 'petstore'
          - 'qa-petstore'
          - 'dev-petstore'
        default: 'petstore'
    port:
      enum:
        - '3000'
        - '1000'
      default: '3000'
    basePath:
      default: v1

To change the default variable, use this function in each Api:

int setDefaultServerValue(int serverIndex,const QString &operation, const QString &variable,const QString &val);

The parameter "serverIndex" will choose a server from the server list for each endpoint. There is always at least one server with index 0. The Parameter "operation" should be the desired endpoint operationid. Variable is the name of the variable you wish to change and the value is the new default Value. The function will return -1 when the variable does not exists, -2 if value is not defined in the variable enum and -3 if the operation is not found.

If your endpoint has multiple server objects in the servers array, you can set the server that will be used with this function:

void setServerIndex(const QString &operation, int serverIndex);

Parameter "operation" should be your operationid. "serverIndex" is the index you want to set as your default server. The function will check if there is a server with your index. Here is an example of multiple servers in the servers array. The first server will have index 0 and the second will have index 1.

servers:
- url: http://{server}:8080/
  description: Description of the Server
  variables:
    server:
        enum:
          - 'petstore'
          - 'qa-petstore'
          - 'dev-petstore'
        default: 'petstore'
- url: https://localhost:8080/v1

Documentation for Authorization

Authentication schemes defined for the API:

ApiKeyAuth

  • Type: API key
  • API key parameter name: x-api-key
  • Location: HTTP header

StoreKeyAuth

  • Type: API key
  • API key parameter name: x-store-key
  • Location: HTTP header

Author

contact@api2cart.com

License

for more information visit

About

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages