CastingONE API Specifications (1.0.0)
API ã®ãšã³ããã€ã³ãã¯ç°å¢ããšã«ä»¥äžã® URL ã«ãªããŸãã
- æ¬çªç°å¢:
https://tn.lb.core.lite.casting-one.jp/api/v1 - ã¹ããŒãžã³ã°ç°å¢:
https://tn-stg.lb.core.lite.casting-one.jp/api/v1
äºåæ€èšŒã§ã¯ã¹ããŒãžã³ã°ç°å¢ããå©çšãã ãããæ£åŒãªãªãŒã¹æã¯æ¬çªç°å¢ã®ãšã³ããã€ã³ããžåãæ¿ããŠãã ããã
API ã®å©çšã«ã¯ã¢ã¯ã»ã¹ããŒãšã¢ã¯ã»ã¹ããŒã¯ã³ãå¿ èŠã§ãã ã¢ã¯ã»ã¹ããŒãšã¢ã¯ã»ã¹ããŒã¯ã³ã¯ç®¡çãµã€ãããçºè¡ã§ããŸãã(äºåã« API 飿ºã®å©çšç³è«ãå¿ èŠã§ã) ã¢ã¯ã»ã¹ããŒãšã¢ã¯ã»ã¹ããŒã¯ã³ã¯ããªã¯ãšã¹ããããã«ä»¥äžã®ããã«å«ããŠãã ããã
curl -X GET \ -H 'x-api-key: API_KEY' \ -H 'x-api-token: API_TOKEN' \ https://tn.lb.core.lite.casting-one.jp/
ã¹ããŒãžã³ã°ç°å¢ãå©çšããå Žåã¯ãäžèš URL ã®ãã¹ãåã tn-stg.lb.core.lite.casting-one.jp ã«å·®ãæ¿ããŠãã ããã
ãªã¹ããè¿ã API ã§ã¯äžåºŠã«è¿ããèŠçŽ ã®æ°ãéå®ãããŠãããããå€ãã®èŠçŽ ãå¿ èŠãšãªãå Žåã¯ããŒãžãæå®ããå¿ èŠããããŸãããªã¹ãã® API ã«ã¯ã1 ããå§ãŸãããŒãžçªå·ã衚ã page ãã©ã¡ãŒã¿ãšã1 ããŒãžãããã«å«ãŸããèŠçŽ æ°ã衚ã per_page ãã©ã¡ãŒã¿ãæå®ããããšãã§ããŸããpage ã®åæå€ã¯ 1 ã«èšå®ãããŠããŸãããŸããper_page ã®åæå€ã¯ 50ãper_page ã®æå€§å€ã¯ 100 ã«èšå®ãããŠããŸãã
ãŸããèŠçŽ ã®ç·ä»¶æ°ã¯ã¬ã¹ãã³ã¹ã® total_count ã§ç¢ºèªã§ããŸããäŸãã°åè£è ã®ç·ä»¶æ°ã 1000 ä»¶ã®å Žåã¯ä»¥äžã®ãããªã¬ã¹ãã³ã¹ã«ãªããŸãã
{
"total_count": 1000,
"candidates": [...]
}
ãªã¹ããè¿ã API ã§ã¯ã䞊ã³é ãç¹å®ã®ããŒã§æå®ã§ãã sort_by ãã©ã¡ãŒã¿ãšãæé éé ãæå®ã§ãã sort_desc ãã©ã¡ãŒã¿ãçšæãããŠããããšããããŸããäŸãã°åè£è ããäœææ¥æãã®ãéé ãã§äžŠã¹ãå Žåã¯ä»¥äžã®ããã«ãªããŸãã
https://tn.lb.core.lite.casting-one.jp/api/v1/candidates?sort_by=created_at&sort_desc=1
åè£è
ã®å€éšé£æºçšIDã¯ã飿ºå
ããšã«æã¡ãŸããåè£è
APIã§ã¯ provider_external_ids ã§é£æºå
ããšã®å€éšé£æºçšIDãèªã¿æžãããŸãã
"provider_external_ids": [
{ "provider_id": 1, "external_ids": ["A-001"] },
{ "provider_id": 2, "external_ids": ["B-001", "B-002"] }
]
åŸæ¥ã®å€éšé£æºçšIDã§ãããæ¬¡ã®ãšã³ããã€ã³ããšãã£ãŒã«ãã¯ãæãIDã®è¥ã飿ºå ã®å€éšé£æºçšIDãšããŠåäœããŸãã2027幎4æã«å»æ¢äºå®ã§ãã ç§»è¡æé ã«åŸããæ°ãããšã³ããã€ã³ãã«åãæ¿ããŠãã ããã
GET/PUT/DELETE /candidates/external/{external_id}- ãªã¯ãšã¹ãã®
external_id - ã¬ã¹ãã³ã¹ã®
external_ids
- åè£è
ã®ç¹å®ã«äœ¿ããšã³ããã€ã³ãã
/candidates/external/{external_id}ãã/candidates/providers/{provider_id}/external_ids/{external_id}ã«åãæ¿ããŠãã ãã - ãªã¯ãšã¹ãã®
external_idãšã¬ã¹ãã³ã¹ã®external_idsã®ä»£ããã«ãprovider_external_idsã䜿çšããŠãã ãã
åè£è APIã®ãªã¯ãšã¹ãã»ã¬ã¹ãã³ã¹ã«ããfree_itemsã®valueã¯ãå ¥å圢åŒã«ãã£ãŠããŒã¿åãšåœ¢åŒãç»é²å¯èœãªå€ãå€ãããŸãã
| å ¥ååœ¢åŒ | ããŒã¿åã»åœ¢åŒ | ç»é²å¯èœãªå€ |
|---|---|---|
| 1:1è¡ããã¹ã | æåå | 500æå以å |
| 2:è€æ°è¡ããã¹ã | æåå | 5000æå以å |
| 3:æ°å€ | æ°å€ | 0~9999999 |
| 4:åäžéžæ | æ°å€ | ããªãŒé ç®ãã¹ã¿ã®masters.id |
| 5:è€æ°éžæ | æ°å€ã®é å | ããªãŒé ç®ãã¹ã¿ã®masters.id |
| 6:å¹Žææ¥ | æåå(yyyy/mm/dd圢åŒ) | 100幎å~100å¹ŽåŸ |
| 7:幎æ | æåå(yyyy/mm圢åŒ) | 100幎å~100å¹ŽåŸ |
| 8:æå» | æåå(hh:mm圢åŒ) | 00:00~23:45ã15ååäœ |
Webhook ã®ãªã¯ãšã¹ããå±ãããããªã¯ãšã¹ããããã«å«ãŸãã眲åãæ€èšŒããŠãã ããããã®æ€èšŒã«ãããCastingONE ãµãŒãããéä¿¡ããã Webhook ãªã¯ãšã¹ãã§ãããããéä¿¡éäžã§æ¹ãããããŠããªããããšã確èªããããšãã§ããŸãã
CastingONE ãµãŒãã§ã¯ãWebhook ãªã¯ãšã¹ãããã£ãå
¥åããŒã¿ãã·ãŒã¯ã¬ããããŒã¯ã³ãããã·ã¥éµãšã㊠HMAC-SHA256 ã§çœ²åãäœæããX-CastingONE-Signature ããããšããŠä»äžããŸãã Webhook ãªã¯ãšã¹ããšçœ²åã¯ä»¥äžã®æé ã§æ€èšŒã§ããŸãã
- åä¿¡ãã Webhook ãªã¯ãšã¹ãããã£ã®æååãå ¥åããŒã¿ãWebhook èšå®äœææã®ã·ãŒã¯ã¬ããããŒã¯ã³ãããã·ã¥éµãšããŠãHMAC-SHA256ã§çœ²åãçæããŸãã
- å蚺ãã眲å(
X-CastingONE-Signature)ãšãçæãã眲åãæ¯èŒããŸãã - 眲åãäžèŽããå Žåã¯ãWebhook ãªã¯ãšã¹ãã®åŠçãè¡ãããšãã§ããŸãã
眲åãäžèŽããªãå Žåã¯ããªã¯ãšã¹ãã CastingONE ãµãŒã以å€ããéä¿¡ããããéä¿¡éäžã§æ¹ãããããããããã¯æ€èšŒæé ã«èª€ããããå¯èœæ§ããããŸãã
Go:
func verifySignature(secretToken string, body []byte, signature string) bool {
hash := hmac.New(sha256.New, []byte(secretToken))
hash.Write(body)
expected := hex.EncodeToString(hash.Sum(nil))
return hmac.Equal([]byte(expected), []byte(signature))
}
Node.js:
const crypto = require("crypto");
function verifySignature(secretToken, body, signature) {
const expected = crypto
.createHmac("sha256", secretToken)
.update(body)
.digest("hex");
return crypto.timingSafeEqual(Buffer.from(expected), Buffer.from(signature));
}
éä¿¡çµè·¯äžã®åé¡ãªã©ã«ãããåã Webhook ã€ãã³ããéè€ããŠéä¿¡ãããå¯èœæ§ããããŸããå Webhook ã€ãã³ããªããžã§ã¯ãã«ã¯äžæãª event_id ãä»äžãããããããããå©çšããŠéè€ã®æ€åºãè¡ãããšãã§ããŸãã