s.yahyaee/yara724-api
1
0
Fork 0
forked from Yara724/api
Code Pull Requests Activity
Files
ebe8671bd3bbd78b14b65776e59aa42034d71e05
yara724-api/docs/external-api-curls.md
s.hajizadeh 2fbf40ef19 log the my policies
2026-06-27 16:50:57 +03:30

15 KiB
Raw Blame History

External API Curl Guide

This file documents outbound HTTP calls made by the app or maintenance scripts. Use placeholder values for secrets, tokens, IDs, plate values, and payloads before running any curl.

Common Notes

  • Internal app URLs in Swagger, localhost examples, and file download URLs are not listed.
  • Package/build-time network calls such as npm registry, Sonar, and Docker setup are not runtime app requests.
  • firstValueFrom(this.httpService...), lastValueFrom(this.httpService...), and fetch(...) call sites were checked.
  • Several integrations cache bearer tokens in memory for about 55 minutes.
  • Some Fanavaran credentials and the Map.ir API key are hardcoded in source. Treat them as sensitive and consider moving/rotating them.

Fanavaran API Manager

Host:

FANAVARAN_BASE_URL="https://apimanager.iraneit.com/BimeApiManager/api"
FANAVARAN_BIME_URL="$FANAVARAN_BASE_URL/BimeApi/v2.0"

Used by:

  • src/fanavaran/fanavaran-lookup.service.ts
  • src/fanavaran/fanavaran-lookup.config.ts
  • src/claim-request-management/claim-request-management.service.ts

Sequence

  1. Get appToken.
  2. Login with appToken to get authenticationToken.
  3. Call lookup, policy inquiry, or submit endpoint with authenticationToken, CorpId, ContractId, and Location.

Tenant Credentials

The app supports these Fanavaran client profiles:

Client appname secret userName password CorpId ContractId Location
tejaratno from src/core/config/fanavaran-client.config.ts hardcoded in source hardcoded in source hardcoded in source 3539 263 100
parsian from src/core/config/fanavaran-client.config.ts hardcoded in source hardcoded in source hardcoded in source 543 28 210050

Set them as shell variables before running:

APP_NAME="<appname>"
APP_SECRET="<secret>"
FANAVARAN_USERNAME="<userName>"
FANAVARAN_PASSWORD="<password>"
CORP_ID="<CorpId>"
CONTRACT_ID="<ContractId>"
LOCATION="<Location>"

1. Get App Token

curl -i -X POST "$FANAVARAN_BASE_URL/EITAuthentication/GetAppToken" \
  -H "appname: $APP_NAME" \
  -H "secret: $APP_SECRET" \
  -H "Content-Length: 0"

The token is returned in a response header named appToken or apptoken.

APP_TOKEN="<response appToken header>"

2. Login

curl -i -X POST "$FANAVARAN_BASE_URL/EITAuthentication/Login" \
  -H "appToken: $APP_TOKEN" \
  -H "userName: $FANAVARAN_USERNAME" \
  -H "password: $FANAVARAN_PASSWORD" \
  -H "Content-Length: 0"

The token is returned in a response header or body field named authenticationToken, authenticationtoken, or authentication_token.

AUTHENTICATION_TOKEN="<response authenticationToken>"

3A. Lookup Endpoints

These are fetched on demand and cached under files/fanavaran-lookups/<client>/.

curl -X GET "$FANAVARAN_BIME_URL/car/base-info/accident-causes" \
  -H "authenticationToken: $AUTHENTICATION_TOKEN" \
  -H "CorpId: $CORP_ID" \
  -H "ContractId: $CONTRACT_ID" \
  -H "Location: $LOCATION" \
  -H "Content-Type: application/json"

curl -X GET "$FANAVARAN_BIME_URL/car/code-list/accident-report-type" \
  -H "authenticationToken: $AUTHENTICATION_TOKEN" \
  -H "CorpId: $CORP_ID" \
  -H "ContractId: $CONTRACT_ID" \
  -H "Location: $LOCATION" \
  -H "Content-Type: application/json"

curl -X GET "$FANAVARAN_BIME_URL/car/base-info/vehicle-use-types" \
  -H "authenticationToken: $AUTHENTICATION_TOKEN" \
  -H "CorpId: $CORP_ID" \
  -H "ContractId: $CONTRACT_ID" \
  -H "Location: $LOCATION" \
  -H "Content-Type: application/json"

curl -X GET "$FANAVARAN_BIME_URL/car/code-list/dmg-pay-method" \
  -H "authenticationToken: $AUTHENTICATION_TOKEN" \
  -H "CorpId: $CORP_ID" \
  -H "ContractId: $CONTRACT_ID" \
  -H "Location: $LOCATION" \
  -H "Content-Type: application/json"

curl -X GET "$FANAVARAN_BIME_URL/car/base-info/driving-licence-types" \
  -H "authenticationToken: $AUTHENTICATION_TOKEN" \
  -H "CorpId: $CORP_ID" \
  -H "ContractId: $CONTRACT_ID" \
  -H "Location: $LOCATION" \
  -H "Content-Type: application/json"

curl -X GET "$FANAVARAN_BIME_URL/car/code-list/accident-culprit-type" \
  -H "authenticationToken: $AUTHENTICATION_TOKEN" \
  -H "CorpId: $CORP_ID" \
  -H "ContractId: $CONTRACT_ID" \
  -H "Location: $LOCATION" \
  -H "Content-Type: application/json"

3B. Policy Inquiry By National Code

Used before Fanavaran claim submit to resolve a PolicyId when possible.

NATIONAL_CODE="<insurer national code>"

curl -X GET "$FANAVARAN_BIME_URL/common/Policies/inquiry-my-policies?InsuranceLineId=5&NationalCode=$NATIONAL_CODE" \
  -H "authenticationToken: $AUTHENTICATION_TOKEN" \
  -H "CorpId: $CORP_ID" \
  -H "ContractId: $CONTRACT_ID" \
  -H "Location: $LOCATION" \
  -H "Content-Type: application/json"

3C. Third-Party Car Financial Claim Submit

fanavaranData is built internally from a claim case/request. The shape is large; capture an app log or preview output and save it as JSON before replaying.

curl -X POST "$FANAVARAN_BIME_URL/car/third-party-car-financial-claims" \
  -H "authenticationToken: $AUTHENTICATION_TOKEN" \
  -H "CorpId: $CORP_ID" \
  -H "ContractId: $CONTRACT_ID" \
  -H "Location: $LOCATION" \
  -H "Content-Type: application/json" \
  --data @fanavaran-claim-submit.json

Tejarat Inquiry Provider

Default base URL:

TEJARAT_INQUIRY_BASE_URL="${TEJARAT_INQUIRY_BASE_URL:-http://82.99.202.245:3027}"

Used by src/sand-hub/sand-hub.service.ts for third-party plate and car-body plate inquiries when ESG is not selected.

Sequence

  1. Login to /user/login.
  2. Use returned accessToken as Authorization: Bearer ....
  3. Call inquiry endpoint.

Login

curl -X POST "$TEJARAT_INQUIRY_BASE_URL/user/login" \
  -H "Accept: */*" \
  -H "Content-Type: application/json" \
  --data '{
    "email": "'"$TEJARAT_INQUIRY_EMAIL"'",
    "password": "'"$TEJARAT_INQUIRY_PASSWORD"'"
  }'

TEJARAT_ACCESS_TOKEN="<response accessToken>"

Third-Party Plate / Policy Block Inquiry

curl -X POST "$TEJARAT_INQUIRY_BASE_URL/block-inquiry-tejarat" \
  -H "Authorization: Bearer $TEJARAT_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  --data '{
    "leftTwoDigits": "12",
    "serialLetter": "ب",
    "threeDigits": "345",
    "rightTwoDigits": "67",
    "nationalCode": "0012345678"
  }'

Car-Body Plate Inquiry

curl -X POST "$TEJARAT_INQUIRY_BASE_URL/block-inquiry-tejarat/badane" \
  -H "Authorization: Bearer $TEJARAT_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  --data '{
    "part1": 12,
    "part2": "ب",
    "part3": 345,
    "part4": 67,
    "nationalCode": "0012345678"
  }'

ESG Inquiry Provider

Default/fallback base URL in some call sites:

ESG_URL="${ESG_URL:-http://192.168.20.22:8085}"

Used by src/sand-hub/sand-hub.service.ts for selected tenants, for example when CLIENT_ID=8.

Sequence

  1. Login to /auth/login.
  2. Use returned accessToken as Authorization: Bearer ....
  3. Call the inquiry endpoint.

Login

curl -X POST "$ESG_URL/auth/login" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  --data '{
    "username": "'"$ESG_USERNAME"'",
    "password": "'"$ESG_PASSWORD"'"
  }'

ESG_ACCESS_TOKEN="<response accessToken>"

Policy By Plate

curl -X POST "$ESG_URL/inquiry/policyByPlate" \
  -H "Authorization: Bearer $ESG_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  --data '{
    "nationalCode": "0012345678",
    "plk1": "12",
    "plk2": "ب",
    "plk3": "345",
    "plksrl": "67"
  }'

Person Inquiry

ESG expects Jalali birth date, normalized as YYYY-MM-DD.

curl -X POST "$ESG_URL/inquiry/person" \
  -H "Authorization: Bearer $ESG_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  --data '{
    "nationalCode": "0012345678",
    "birthDate": "1378-11-24",
    "dateHasPostfix": 0
  }'

Sheba Validation

curl -X POST "$ESG_URL/inquiry/sheba" \
  -H "Authorization: Bearer $ESG_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  --data '{
    "accountOwnerType": "1",
    "nationalCode": "0012345678",
    "legalId": "",
    "sheba": "IR000000000000000000000000"
  }'

SandHub Provider

Used by src/sand-hub/sand-hub.service.ts for legacy inquiry flows.

Environment:

SANHUB_URL_LOGIN="<login URL>"
SANHUB_BASE_URL="<base URL>"

Sequence

  1. Login through SANHUB_URL_LOGIN.
  2. Use returned accessToken as Authorization: Bearer ....
  3. Call the required endpoint under SANHUB_BASE_URL.

Login

curl -X POST "$SANHUB_URL_LOGIN" \
  -H "Content-Type: application/json" \
  --data '{
    "email": "'"$SANHUB_USERNAME"'",
    "password": "'"$SANHUB_PASSWORD"'"
  }'

SANHUB_ACCESS_TOKEN="<response accessToken>"

Third-Party Plate / Policy Block Inquiry

curl -X POST "$SANHUB_BASE_URL/block-inquiry-tejarat" \
  -H "Authorization: Bearer $SANHUB_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  --data '{
    "leftTwoDigits": "12",
    "serialLetter": "ب",
    "threeDigits": "345",
    "rightTwoDigits": "67",
    "nationalCode": "0012345678"
  }'

Personal Inquiry

The app converts Jalali birth dates to Gregorian before sending to SandHub.

curl -X POST "$SANHUB_BASE_URL/personal-inquiry/tejarat-no" \
  -H "Authorization: Bearer $SANHUB_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  --data '{
    "nationalCode": "0012345678",
    "birthdate": "1999-02-13"
  }'

Driving License Check

curl -X POST "$SANHUB_BASE_URL/driver-license-check" \
  -H "Authorization: Bearer $SANHUB_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  --data '{
    "driverLicenseNumber": "1234567890",
    "nationalCode": "0012345678"
  }'

Car Ownership

curl -X POST "$SANHUB_BASE_URL/ownership" \
  -H "Authorization: Bearer $SANHUB_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  --data '{
    "Plk1": "12",
    "Plk2": "ب",
    "Plk3": "345",
    "plkSrl": "67",
    "nationalCode": "0012345678"
  }'

Sheba Validation

curl -X POST "$SANHUB_BASE_URL/sheba/sheba-tejaratno" \
  -H "Authorization: Bearer $SANHUB_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  --data '{
    "AccountOwnerType": "1",
    "NationalId": "0012345678",
    "ShebaId": "IR000000000000000000000000"
  }'

Map.ir Reverse Geocoding

Used by src/claim-request-management/claim-request-management.service.ts.

MAP_IR_API_KEY="<x-api-key>"
LAT="35.6892"
LON="51.3890"

curl -X GET "https://map.ir/fast-reverse?lat=$LAT&lon=$LON" \
  -H "accept: application/json" \
  -H "x-api-key: $MAP_IR_API_KEY"

SMS Providers

Kavenegar

Used by src/sms-orchestration/provider/kavenegar.service.ts.

SMS_API_KEY="<kavenegar API key>"
KAVENEGAR_BASE_URL="https://api.kavenegar.com/v1/$SMS_API_KEY"

Send SMS:

curl -X POST -G "$KAVENEGAR_BASE_URL/sms/send.json" \
  --data-urlencode "receptor=09120000000" \
  --data-urlencode "message=Hello" \
  --data-urlencode "sender=<optional sender>"

Verify lookup:

curl -G "$KAVENEGAR_BASE_URL/verify/lookup.json" \
  --data-urlencode "receptor=09120000000" \
  --data-urlencode "token=123456" \
  --data-urlencode "template=<template>" \
  --data-urlencode "token2=<optional token2>" \
  --data-urlencode "token3=<optional token3>"

Parsian SMS Gateway

Used by src/sms-orchestration/provider/parsian-sms.gateway.ts.

PARSIAN_SMS_URL is expected to already include the provider URL prefix and query key before receptor. The app appends =<receptor>&Message=<encoded message>.

PARSIAN_SMS_URL="<provider URL prefix>"
PARSIAN_API_KEY="<package API key>"
PARSIAN_BASIC_TOKEN="<basic token>"
RECEPTOR="09120000000"
MESSAGE="Hello"

curl -X GET "$PARSIAN_SMS_URL=$RECEPTOR&Message=$(printf %s "$MESSAGE" | jq -sRr @uri)" \
  -H "Content-Type: application/json" \
  -H "X-PACKAGE-API-KEY: $PARSIAN_API_KEY" \
  -H "Authorization: Basic $PARSIAN_BASIC_TOKEN"

Car Price Provider

Used by src/expert-claim/expert-claim.service.ts to fetch car prices from CW_URL.

CW_URL="<base URL ending with slash if required by provider>"

curl -X GET "${CW_URL}price?akharin"
curl -X GET "${CW_URL}price?hamrah"

AI Service Calls Currently Disabled

src/ai/ai.service.ts contains configured URLs but the actual axios calls are commented out. If re-enabled, the sequence is:

  1. POST $AI_URL_V2/auth/login
  2. GET $AI_URL_V2/auth/profile
  3. POST $AI_URL_V2/services/car-damage/detector?version=ai-v7
AI_URL_V2="<AI service base URL>"

curl -X POST "$AI_URL_V2/auth/login" \
  -H "Content-Type: application/json" \
  --data '{
    "username": "'"$AI_USERNAME"'",
    "password": "'"$AI_PASSWORD"'"
  }'

AI_ACCESS_TOKEN="<response accessToken>"

curl -X GET "$AI_URL_V2/auth/profile" \
  -H "Authorization: Bearer $AI_ACCESS_TOKEN"

GATEWAY_API_KEY="<profile apiKey.key>"

curl -X POST "$AI_URL_V2/services/car-damage/detector?version=ai-v7" \
  -H "Authorization: Bearer $AI_ACCESS_TOKEN" \
  -H "gateway-api-key: $GATEWAY_API_KEY" \
  -F "images=@/path/to/car-image.jpg"

Refresh Blame Inquiries Script

Used by scripts/refresh-blame-inquiries.js. This script does not login; it expects pre-provided bearer tokens:

  • TEJARAT_THIRD_PARTY_TOKEN or TEJARAT_TOKEN
  • TEJARAT_CAR_BODY_TOKEN or TEJARAT_TOKEN
  • TEJARAT_PERSON_TOKEN or TEJARAT_TOKEN

Default URLs:

TEJARAT_THIRD_PARTY_URL="${TEJARAT_THIRD_PARTY_URL:-http://82.99.202.245:3027/block-inquiry-tejarat}"
TEJARAT_CAR_BODY_URL="${TEJARAT_CAR_BODY_URL:-http://82.99.202.245:3027/block-inquiry-tejarat/badane}"
TEJARAT_PERSON_URL="${TEJARAT_PERSON_URL:-http://82.99.202.245:3027/personal-inquiry/tejarat-no}"

Third-party inquiry:

curl -X POST "$TEJARAT_THIRD_PARTY_URL" \
  -H "authorization: Bearer $TEJARAT_THIRD_PARTY_TOKEN" \
  -H "content-type: application/json" \
  -H "accept: application/json" \
  --data '{
    "leftTwoDigits": "12",
    "serialLetter": "ب",
    "threeDigits": "345",
    "rightTwoDigits": "67",
    "nationalCode": "0012345678"
  }'

Car-body inquiry:

curl -X POST "$TEJARAT_CAR_BODY_URL" \
  -H "authorization: Bearer $TEJARAT_CAR_BODY_TOKEN" \
  -H "content-type: application/json" \
  -H "accept: application/json" \
  --data '{
    "part1": 12,
    "part2": "ب",
    "part3": 345,
    "part4": 67,
    "nationalCode": "0012345678"
  }'

Personal inquiry:

curl -X POST "$TEJARAT_PERSON_URL" \
  -H "authorization: Bearer $TEJARAT_PERSON_TOKEN" \
  -H "content-type: application/json" \
  -H "accept: application/json" \
  --data '{
    "nationalCode": "0012345678",
    "birthdate": "1999-02-13"
  }'
View Git Blame Copy Permalink