Get Sources API

이 문서는 특정 회사에 연결된 소스 데이터를 확인하기 위한 getSources API에 대한 설명을 제공합니다.

인증

API에 접근하기 위해서는 API Key가 필요합니다. 다음은 예시입니다:

curl -X GET https://app-api-v2.commerceos.ai/open/v1/sources \
     -H "x-api-key: YOUR_API_KEY"

엔드포인트

소스 데이터 가져오기

엔드포인트: GET /open/v1/sources

요청

필드	타입	필수 여부	설명
`x-api-key` (헤더)	string	예	사용자별 API Key.

예시 요청

curl -X GET https://app-api-v2.commerceos.ai/open/v1/sources \
     -H "x-api-key: YOUR_API_KEY"

응답

필드	타입	필수 여부	설명
`meta`	meta	예	API에 대한 결과와 응답 메시지를 담고 있습니다.
`data`	array `Source`	예	`Source` 객체의 배열입니다.

Source

필드	타입	필수 여부	설명
`id`	string	예	소스의 고유 ID입니다.
`name`	string	예	소스의 이름입니다.
`description`	string	예	소스에 대한 설명을 담고 있습니다.
`structure`	`FieldObject`	예	소스가 지원하는 Data Structure구조를 설명합니다.

FieldObject

필드	타입	필수 여부	설명
`type`	string	예	Field의 타입을 의미합니다. ex. String, Number, Boolean, Array, Object
`required`	string	예	소스의 이름입니다.
`arrayField`	`FieldObject`	아니요	type이 Array일때 해당 값의 Data Structure구조를 설명합니다.
`objectField`	`map(FieldObject)`	아니요	type이 Object일때 해당 값의 Data Structure구조를 설명합니다.

Status: 200 OK
Body:

{
    "meta": {
        "code": "Success",
        "message": "ok"
    },
    "data": [
        {
            "id": "1234567",
            "name": "product",
            "description": "제품의 결과 요약",
        },
        {
            "id": "22334531",
            "name": "recipt",
            "description": "제품 거래 정보",
        }
    ]
}

Get Source Rows