ko
핀테크

API 문서

클라이언트 사이트, 백오피스 및 모든 플랫폼 모듈은 API를 통해 데이터베이스 파일과 함께 작동하며 직접 작동하지 않습니다. API는 수신 데이터의 액세스, 무결성 및 정확성을 제어합니다.

일반적인 설명

API는 어떻게 작동합니까?

API - 플랫폼의 핵심 노드

이 문서에서는 다음 작업에 대한 모든 API 메서드를 설명합니다.

  • 개체 목록 가져오기(목록 메서드)
  • 목록 필터링(필터 데이터가 있는 목록 방법)
  • 객체에 대한 자세한 정보 얻기(show 메소드)
  • 개체 추가 양식에 대한 데이터 가져오기(add 메서드)
  • 데이터를 새 객체로 저장(저장 방법)
  • 개체 업데이트 양식에 대한 데이터 가져오기(편집 방법)
  • 업데이트된 객체의 데이터 저장(업데이트 방법)

IP 주소로 확인

API는 제한된 IP 주소 목록(예: 클라이언트 계정 사이트 또는 백오피스 사이트)의 요청만 수락합니다.

허용 목록에 없는 IP 주소에서 API에 대한 모든 요청은 거부됩니다.

이는 API에 대한 DDoS 공격, 요청 위조 시도 및 해커 실험을 방지하기 위해 수행됩니다.

사용자는 항상 플랫폼의 공개 사이트(고객 사무실 또는 백오피스)에 액세스하며 이 사이트 자체에서 플랫폼의 API에서 필요한 데이터를 요청합니다. 사이트의 IP 주소는 고정되어 있으므로 허용 목록에 있습니다.

URL 및 방법

모든 API 요청은 다음 HTTP 메서드를 사용하여 이루어집니다.

  • GET 목록, 표시, 추가 및 편집용
  • POST 매장용
  • PUT 업데이트를 위해
  • DELETE 삭제를 위해

API의 각 섹션에는 관련 데이터를 얻기 위해 요청되는 URL이 포함되어 있습니다.

HTTP 요청 방법은 각 URL 앞에 지정됩니다.

요청 보내기

각 API 요청에는 항상 4개의 변수가 포함되어야 합니다.

  1. data (API용 데이터 배열이 있는 json 문자열)
  2. user (현재 사용자에 대한 데이터 배열이 있는 json 문자열)
  3. time (UTC 시간대의 현재 시간)
  4. hash (API에 대한 요청이 승인된 출처에서 온 것인지 확인하기 위한 해시 형식의 디지털 서명)

API에서 응답 받기

요청이 성공하면 API는 항상 두 개의 변수를 반환합니다.

  1. status = true (성공 상태)
  2. data (API의 데이터 배열이 있는 json 문자열)

요청이 실패하면 API에 변수가 표시됩니다.

  1. status = false (오류 상태)
  2. error (오류를 설명하는 텍스트 문자열)

전자 서명

각 API 요청에는 요청의 디지털 서명인 해시 변수가 포함되어야 합니다.

hash = md5($json . $time . $salt)

  • md5, sha256, bcrypt — 사용 가능한 암호화 알고리즘
  • $json — 요청 데이터가 있는 json 문자열
  • $time — "DD.MM.YYYY HH:MM:SS" 형식의 시간
  • $salt — 플랫폼 API에 대한 고정 고유 값("소금")

핀테크

설명서에는 실제 API 요청의 예가 포함되어 있습니다.